DbVisualizer でSage X3 Cloud のデータに連携しクエリを作成



CData JDBC Driver for SageX3Cloud は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでSage X3 Cloud のデータへの接続を提供します。この記事では、DbVisualizer からSage X3 Cloud のデータに接続する方法、およびtable エディタを使ってSage X3 Cloud をロード、する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. Sage X3 Cloud をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにSage X3 Cloud のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてSage X3 Cloud の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

Sage X3 Cloud のデータの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからSage X3 Cloud のデータに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData Sage X3 Cloud Driver）。
   • URL Format をjdbc:sagex3cloud: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.SageX3Cloud.jar）を選択して「Open」をクリックします。
     
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.sagex3cloud.SageX3CloudDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:sagex3cloud: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

     • URL：Sage X3 Cloud インスタンスのベース URL。
     • OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
     • OAuthClientId：OAuth アプリケーションのクライアント ID。
     • OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
     • Audience：トークンリクエストで使用する API の Audience 値。
     • XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
     • Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
     • Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

     ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、Sage X3 Cloud JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     
     java -jar cdata.jdbc.sagex3cloud.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     
     jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;
     

   • NOTE：Sage X3 Cloud は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
3. 「Connection」タブで「Connect」をクリックします。

Sage X3 Cloud JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに

CData JDBC Driver for SageX3Cloud の 30日間無償トライアル をダウンロードして、DbVisualizer でリアルタイムSage X3 Cloud のデータの操作をはじめましょう！ご不明な点があれば、サポートチームにお問い合わせください。