C++Builder でClio のデータにデータバインドするコントロールを作成

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
C++Builder で標準コンポーネントとコントロールを使ってClio のデータ にデータバインド。

CData ODBC ドライバー for Clio を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのClio のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL（Visual Component Library）アプリケーションを作成し、Clio のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。

Clio のデータへの接続を作成

まだ設定していない場合は、ODBC DSN（データソース名）で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。

まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。

Clio API プロファイル設定

Clio はOAuth ベースの認証を使用します。

まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：アプリ設定で指定されたclient_id に設定します。
  • OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
  • CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
  • Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。

次に、以下の手順に従って Data Explorer を使用し、Clio への FireDAC 接続を作成します。

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

Clio のデータに接続する VCL アプリケーションを作成

以下の手順に従って、クエリの結果をグリッドに表示するシンプルな VCL アプリケーションからClio のデータ のクエリを開始します。

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

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

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

    • Connection：TFDConnection コンポーネントに設定します（まだ指定されていない場合）。

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

      SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'
    • Active：このプロパティを true に設定します。

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

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

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

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

FireDAC コンポーネントを使ってClio にコマンドを実行

TFDConnection および TFQuery コンポーネントを使用して、Clio のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のClio 固有の例を紹介します。

Clio のデータに接続

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

FDConnection1->ConnectionDefName = "CData Clio ODBC Source";
FDConnection1->Connected = true;

TFDQuery コンポーネントをClio のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。

パラメータ化クエリの作成

パラメータ化クエリを作成するには、以下の構文を使用します： 

FDQuery1->SQL->Text = "select * from Bills where state = :State";
FDQuery1->ParamByName("state")->AsString = "awaiting_payment";
FDQuery1->Open();

上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。

ステートメントの準備

ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。

クエリの実行

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

FDQuery1->SQL->Text = "select * from Bills where state = :State";
FDQuery1->ParamByName("state")->AsString = "awaiting_payment";
FDQuery1->Open();

関連記事

以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。

はじめる準備はできましたか？

API Driver で Clio のライブデータに接続

Clio に接続 お問い合わせ

この記事の内容

関連記事