DBeaver からSage X3 Cloud のデータに連携して可視化する方法とは？



CData JDBC Driver for SageX3Cloud は、IDE からBI ツールまで、サードパーティーツールからSage X3 Cloud のデータの読み書きを可能にするJDBC 標準を提供します。本記事では、DBeaver のウィザードを使ってSage X3 Cloud のデータに接続し、GUI 上でデータを参照する方法を紹介します。

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つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData JDBC ドライバのインストールとSage X3 Cloud への接続設定

まずは、本記事右側のサイドバーからSageX3Cloud JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

次に、以下の手順でDBeaver にドライバーのJAR ファイルをロードします。

1. DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
2. 設定タブで：
   • ドライバ名をわかりやすい名前に設定します（例：CData JDBC Driver for Sage X3 Cloud）。
   • クラス名をJDBC ドライバーのクラス名「cdata.jdbc.sagex3cloud.SageX3CloudDriver」に設定します。
   • URL テンプレートをjdbc:sagex3cloud: に設定します。
   
3. ライブラリタブで「ファイルを追加」をクリックし、インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud XXXX\）の「lib」フォルダに移動してJAR ファイル（cdata.jdbc.SageX3Cloud.jar）を選択します。

Sage X3 Cloud のデータの接続を作成

以下の手順で、認証情報およびその他の必要な接続プロパティを追加します。

1. 「データベース」メニューで、「新しい接続」をクリックします。
2. 表示される「新しい接続を作成する」 ウィザードで、先ほど作成したドライバー（例：CData JDBC Driver for Sage X3 Cloud）を選択し、「次へ >」をクリックします。
3. 設定ウィザードの一般タブで、以下を参考に必要な接続プロパティを使用してJDBC URL を設定します。

   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: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;
   

   
4. 「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
5. 「終了」をクリックします。

Sage X3 Cloud のデータにクエリを実行

これで、接続できたことで公開されたテーブルのデータにクエリを実行できるようになりました。テーブルを右クリックし、「ビュー表」をクリックします。「データ」タブでデータを確認できます。

おわりに

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