Delphi のZoho CRM のデータへのデータバインドコントロール
CData ODBC Driver for ZohoCRM は、ODBC 標準をサポートし、リアルタイムZoho CRM のデータとビジュアルフォームデザイナおよびDelphi の他のラピッド開発ツールとの統合を可能にします。ODBC ドライバーは、データベース開発用のシングルAPI を提供することにより、Delphi のような単一のコードベースを共有するアプリケーションのデータアクセス戦略を簡素化します。この記事では、Zoho CRM に接続してシンプルなVisual Component Library (VCL) アプリケーションおよびDelphi コードからデータをクエリする方法を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Zoho CRM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにZoho CRM のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてZoho CRM の接続を設定、2.Delphi 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとZoho CRM への接続設定
まずは、本記事右側のサイドバーからZohoCRM ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
未指定の場合は、初めにODBC DSN (data source name) で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および構成できます。
Zoho CRM への接続
それでは、Zoho CRM に接続していきましょう。データに接続するには、以下の接続パラメータを設定します。
- Region:Zoho CRM サーバーURL のドメインに関連付けられたリージョン
- Schema:Zoho CRM のバージョン(v2、v2.1、またはv4)。Zoho CRM のバージョンごとに独自のデータモデルがあります
これらのプロパティに加えて、認可時にサンドボックスまたは開発者インスタンスのいずれかを選択した場合は、InstanceType 接続プロパティでも同じ設定を行ってください。
Zoho CRM への認証
Zoho CRM では、データへの認証に2つの方法が用意されています。お使いの環境に応じて適切な方法を選択てください。
デスクトップ経由で自分のローカルデータに認証を行う場合(非ブラウザ接続):CData 製品が提供する埋め込みOAuth アプリケーションを使用
CData 製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続では、自動的に組み込みアプリケーションが使用されます。 OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する手間を省くには、InitiateOAuth をGETANDREFRESH に設定してください。
ネットワーク経由で共有データに認証を行う場合(ブラウザ接続):カスタムOAuth アプリケーションを使用
すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。
より詳細な認証手順については、ヘルプドキュメントの「Zoho CRM への認証」をご確認ください。
以下のステップに従ってData Explorer を使用し、Zoho CRM へのFireDAC 接続を作成できます。
- 新しいVCL Forms アプリケーションの[Data Explorer]で[FireDAC]ノードを展開します。
- [Data Explorer]で[ODBC Data Source]ノードを右クリックします。
- [Add New Connection]をクリックします。
- 接続の名前を入力します。
- 表示される[FireDAC Connection Editor]で、[DataSource]プロパティをODBC DSN for ZohoCRM の名前に設定します。
Zoho CRM のデータに接続できるVCL アプリケーションの作成
以下のステップに従って、クエリの結果をグリッドに表示するシンプルなVCL アプリケーションからZoho CRM のクエリの実行を開始します。
-
TFDConnection コンポーネントフォームにドロップし、以下のプロパティを設定します。
- ConnectionDefName:Zoho CRM へのFireDAC 接続を選択します。
- Connected:メニューから[True]を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- Connection:コンポーネントがまだ指定されていない場合は、このプロパティを[TFDConnection]コンポーネントに設定します。
SQL:[SQL]プロパティ内のボタンをクリックし、クエリを入力します。例:
SELECT Account_Name, Annual_Revenue FROM Accounts
- Active:このプロパティをtrue に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- DataSet:このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します。
- DataSource:TDataSource の名前を選択します。
- 実行時エラーを回避するために、TFDGUIxWaitCursor をフォームにドロップします。
FireDAC コンポーネントを使用してZoho CRM へのコマンドを実行
TFDConnection およびTFQuery コンポーネントを使用してZoho CRM へのクエリを実行できます。このセクションでは、TFQuery コンポーネントを使用してクエリを実行するZoho CRM 固有の例を示します。
Zoho CRM のデータに接続
データソースに接続するには、TFDConnection コンポーネントの[Connected]プロパティをtrue に設定します。コードでも同じプロパティを設定できます。
FDConnection1.ConnectionDefName := 'myzohocrm'; FDConnection1.Connected := true;
パラメータクエリの作成
パラメータ化されたリソースはパフォーマンスを向上させることができます。ステートメントの準備は、システムリソースと時間の面でコストがかかります。ステートメントの準備中、接続がアクティブで開いている必要があるためです。FireDACはデフォルトで、同じクエリが何度もリコンパイルされないようにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を[True]に設定します。クエリを一回だけ実行する必要がある場合などに設定します。
クエリの実行
select クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドは、クエリを実行して結果セットを返し、それを開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。
FDQuery1.Open('select * from Accounts where Industry = :Industry',['Data/Telecom OEM']);
delete のような結果セットを返さないクエリを実行するには、ExecSQL メソッドを使用します。クエリが結果セットを返す場合、ExecSQL メソッドはエラーを返します。影響を受ける行の数を取得するには、[TFD.RowsAffected]プロパティを使用します。
FDQuery1.ExecSQL('delete from Accounts where Id= :myId',['x12345']);
i := FDQuery1.RowsAffected;
おわりに
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。