C++Builder でSAP Ariba Source のデータにデータバインドするコントロールを作成
CData ODBC ドライバー for SAP Ariba Source を使用すると、C++Builder の標準データアクセスコンポーネントを使ってライブのSAP Ariba Source のデータ への接続を簡単に統合できます。この記事では、C++Builder でシンプルな VCL(Visual Component Library)アプリケーションを作成し、SAP Ariba Source のデータ に接続してクエリを実行し、グリッドに結果を表示する方法を説明します。さらに、FireDAC コンポーネントを使ってコードからコマンドを実行する方法も紹介します。
SAP Ariba Source のデータへの接続を作成
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。
それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。
- API:CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します(可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です)
- DataCenter:アカウントのデータがホストされているデータセンター
- Realm:アクセスしたいサイト名
- Environment:テスト環境、または本番環境のいずれかを指定してください。(可能な値は、TEST またはPRODUCTION)
Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。
- User:API 呼び出しを行うユーザーのId
- PasswordAdapter:認証するUser に関連付けられたパスワード
Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。
OAuth 認証
続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。
- AuthScheme をOAuthClient に設定します
- サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります
OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。
OAuth の自動リフレッシュ
以下のプロパティを設定して、接続してみましょう。
- APIKey:アプリケーション設定のApplication key
- OAuthClientId:アプリケーション設定のOAuth Client Id
- OAuthClientSecret:アプリケーション設定のOAuth Secret
接続すると、CData 製品が自動でOAuth プロセスを完了します。
- CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
- CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
- OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます
次に、以下の手順に従って Data Explorer を使用し、SAP Ariba Source への FireDAC 接続を作成します。
- 新しい VCL Forms アプリケーションで、Data Explorer の FireDAC ノードを展開します。
- Data Explorer の ODBC Data Source ノードを右クリックします。
- Add New Connection をクリックします。
- 接続の名前を入力します。
- 表示される FireDAC Connection Editor で、DataSource プロパティをSAP Ariba Source の ODBC DSN の名前に設定します。
SAP Ariba Source のデータに接続する VCL アプリケーションを作成
以下の手順に従って、クエリの結果をグリッドに表示するシンプルな VCL アプリケーションからSAP Ariba Source のデータ のクエリを開始します。
-
TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- ConnectionDefName:SAP Ariba Source への FireDAC 接続を選択します。
- Connected:メニューから True を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- Connection:TFDConnection コンポーネントに設定します(まだ指定されていない場合)。
SQL:SQL プロパティのボタンをクリックし、クエリを入力します。例:
SELECT SMVendorID, Category FROM Vendors WHERE Region = 'USA'
- Active:このプロパティを true に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します:
- DataSet:このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します:
- DataSource:TDataSource の名前を選択します。
- TFDGUIxWaitCursor をフォームにドロップします — これは実行時エラーを回避するために必要です。
FireDAC コンポーネントを使ってSAP Ariba Source にコマンドを実行
TFDConnection および TFQuery コンポーネントを使用して、SAP Ariba Source のデータ にクエリを実行できます。このセクションでは、TFQuery コンポーネントを使ったクエリ実行のSAP Ariba Source 固有の例を紹介します。
SAP Ariba Source のデータに接続
データソースに接続するには、TFDConnection コンポーネントの Connected プロパティを true に設定します。コードから同じプロパティを設定することもできます:
FDConnection1->ConnectionDefName = "CData SAP Ariba Source ODBC Source"; FDConnection1->Connected = true;
TFDQuery コンポーネントをSAP Ariba Source のデータ に接続するには、コンポーネントの Connection プロパティを設定します。設計時に TFDQuery コンポーネントを追加すると、上記のアプリケーションのように、その Connection プロパティはフォーム上の TFDConnection を指すように自動的に設定されます。
パラメータ化クエリの作成
パラメータ化クエリを作成するには、以下の構文を使用します:
FDQuery1->SQL->Text = "select * from Vendors where region = :Region";
FDQuery1->ParamByName("region")->AsString = "USA";
FDQuery1->Open();
上記の例では、文字列型の入力パラメータを名前でバインドし、結果のデータセットを開いています。
ステートメントの準備
ステートメントの準備は、システムリソースと時間の両方でコストがかかります。ステートメントの準備中は、接続がアクティブで開いている必要があります。デフォルトでは、FireDAC は同じクエリを何度もコンパイルすることを避けるためにクエリを準備します。ステートメントの準備を無効にするには、ResourceOptions.DirectExecute を True に設定します。例えば、クエリを一度だけ実行する必要がある場合などです。
クエリの実行
SELECT クエリなど、結果セットを返すクエリを実行するには、Open メソッドを使用します。Open メソッドはクエリを実行し、結果セットを返して開きます。クエリが結果セットを生成しない場合、Open メソッドはエラーを返します。
FDQuery1->SQL->Text = "select * from Vendors where region = :Region";
FDQuery1->ParamByName("region")->AsString = "USA";
FDQuery1->Open();
結果セットを返さないクエリを実行するには、ExecSQL メソッドを使用します。クエリが結果セットを返す場合、ExecSQL メソッドはエラーを返します。影響を受けた行数を取得するには、TFD.RowsAffected プロパティを使用します。
FDQuery1->SQL->Text = "delete from Vendors where Id = :Id";
FDQuery1->Params->Items[0]->AsString = "x12345";
FDQuery1->ExecSQL();
AnsiString i = FDQuery1->RowsAffected;
ShowMessage("Rows affected: " + i);
関連記事
以下に、RAD Studio、Delphi、C++ Builder で CData ODBC ドライバーを使用するための他の記事を紹介します。