Delphi のAcumatica のデータへのデータバインドコントロール

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData ODBC Driver for Acumatica は、ODBC 標準をサポートし、リアルタイムAcumatica のデータとビジュアルフォームデザイナおよびDelphi の他のラピッド開発ツールとの統合を可能にします。ODBC ドライバーは、データベース開発用のシングルAPI を提供することにより、Delphi のような単一のコードベースを共有するアプリケーションのデータアクセス戦略を簡素化します。この記事では、Acumatica に接続してシンプルなVisual Component Library (VCL) アプリケーションおよびDelphi コードからデータをクエリする方法を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

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

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

CData ODBC ドライバのインストールとAcumatica への接続設定

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

未指定の場合は、初めにODBC DSN (data source name) で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および構成できます。

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」を参照してください。

以下のステップに従ってData Explorer を使用し、Acumatica へのFireDAC 接続を作成できます。

1. 新しいVCL Forms アプリケーションの［Data Explorer］で［FireDAC］ノードを展開します。
2. ［Data Explorer］で［ODBC Data Source］ノードを右クリックします。
3. ［Add New Connection］をクリックします。
4. 接続の名前を入力します。
5. 表示される［FireDAC Connection Editor］で、［DataSource］プロパティをODBC DSN for Acumatica の名前に設定します。

Acumatica のデータに接続できるVCL アプリケーションの作成

以下のステップに従って、クエリの結果をグリッドに表示するシンプルなVCL アプリケーションからAcumatica のクエリの実行を開始します。

1. TFDConnection コンポーネントフォームにドロップし、以下のプロパティを設定します。

   • ConnectionDefName：Acumatica へのFireDAC 接続を選択します。
   • Connected：メニューから［True］を選択し、表示されるダイアログで資格情報を入力します。

2. TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します。

   • Connection：コンポーネントがまだ指定されていない場合は、このプロパティを［TFDConnection］コンポーネントに設定します。

   • SQL：［SQL］プロパティ内のボタンをクリックし、クエリを入力します。例：

     SELECT Id, location_displayname FROM Events
   • Active：このプロパティをtrue に設定します。

3. TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します。

   • DataSet：このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。

4. TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します。

   • DataSource：TDataSource の名前を選択します。
5. 実行時エラーを回避するために、TFDGUIxWaitCursor をフォームにドロップします。

FireDAC コンポーネントを使用してAcumatica へのコマンドを実行

TFDConnection およびTFQuery コンポーネントを使用してAcumatica へのクエリを実行できます。このセクションでは、TFQuery コンポーネントを使用してクエリを実行するAcumatica 固有の例を示します。

Acumatica のデータに接続

データソースに接続するには、TFDConnection コンポーネントの［Connected］プロパティをtrue に設定します。コードでも同じプロパティを設定できます。

パラメータクエリの作成

パラメータ化されたリソースはパフォーマンスを向上させることができます。ステートメントの準備は、システムリソースと時間の面でコストがかかります。ステートメントの準備中、接続がアクティブで開いている必要があるためです。FireDACはデフォルトで、同じクエリが何度もリコンパイルされないようにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を［True］に設定します。クエリを一回だけ実行する必要がある場合などに設定します。

クエリの実行

select クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドは、クエリを実行して結果セットを返し、それを開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。

delete のような結果セットを返さないクエリを実行するには、ExecSQL メソッドを使用します。クエリが結果セットを返す場合、ExecSQL メソッドはエラーを返します。影響を受ける行の数を取得するには、［TFD.RowsAffected］プロパティを使用します。

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。