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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData JDBC ドライバとは？

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

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

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

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

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

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

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:acumatica: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Acumatica 接続プロパティの取得・設定方法

     Acumatica への接続

     Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。

     • Url：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
     • Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
     • Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
     • EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：17.200.001。これはREST スキーマにのみ適用されます。
     • EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。
     詳細はヘルプドキュメントの「接続の確立」セクションを参照してください。

     Acumatica への認証

     Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。

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

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

     java -jar cdata.jdbc.acumatica.jar

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

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

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

     jdbc:acumatica:Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User=user;Password=password;Company=CompanyName;
   • NOTE：Database Userid とDatabase Password は、それぞれAcumatica のUser プロパティとPassword プロパティに対応しています。
3. 「Connection」タブで「Connect」をクリックします。

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

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

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

おわりに