Paylocity のデータ 用のシンプルな VCL アプリケーションを構築

Embarcadero RAD Studio は、Delphi および C++Builder アプリケーション用の開発環境を提供します。CData ODBC Driver for Paylocity を使用すると、RAD Studio 内からリアルタイムPaylocity のデータにアクセスでき、データをテーブル、ビュー、ストアドプロシージャとして抽象化してPaylocity のデータの取得および更新が可能です。この記事では、Paylocity に接続し、フォームデザイナを使用してシンプルな VCL アプリケーションを作成する方法を説明します。

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 フォームアプリケーションで、Data Explorer の FireDAC ノードを展開します。
2. Data Explorer で ODBC Data Source ノードを右クリックします。
3. ［新しい接続の追加］ をクリックします。
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 をフォームにドロップします。これはランタイムエラーを回避するために必要です。

これで、TFDQuery オブジェクトに設定された SQL クエリの結果を表示する実行可能なアプリケーションが完成しました。

関連記事

RAD Studio、Delphi、C++ Builder で CData ODBC ドライバを使用するその他の記事は以下をご覧ください。

• C++Builder で Paylocity のデータ にコントロールをデータバインド
• Delphi で Paylocity のデータ にコントロールをデータバインド
• RAD Studio Data Explorer で Paylocity のデータ を表示