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

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

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

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

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

Paylocity への接続を確立するには以下を設定します。

  • RSAPublicKey：Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。

    このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。

  • UseSandbox：サンドボックスアカウントを使用する場合はTrue に設定。
  • CustomFieldsCategory：Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
  • Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。これはコンテンツを暗号化するためのキーです。

    Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
    これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。

  • IV：コンテンツを暗号化するときに使用するAES IV（base 64 エンコード）。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。

OAuth

OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。

Pay Entry API

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。

UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。

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

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

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

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

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

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

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

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

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

      SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
    • Active：このプロパティを true に設定します。

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

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

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

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

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

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

Paylocity のデータに接続

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

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

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

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

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

FDQuery1->SQL->Text = "select * from Employee where employeeid = :EmployeeId";
FDQuery1->ParamByName("employeeid")->AsString = "1234";
FDQuery1->Open();

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

ステートメントの準備

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

クエリの実行

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

FDQuery1->SQL->Text = "select * from Employee where employeeid = :EmployeeId";
FDQuery1->ParamByName("employeeid")->AsString = "1234";
FDQuery1->Open();

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

FDQuery1->SQL->Text = "delete from Employee 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 ドライバーを使用するための他の記事を紹介します。

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

Paylocity ODBC Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Paylocity Icon Paylocity ODBC Driver お問い合わせ

Paylocity ODBC Driver を使って、ODBC 接続をサポートする多様なツールからPaylocity にデータ連携。

DB のようにPaylocity データへODBC インターフェースでアクセス可能に。

この記事の内容

関連記事