Viewing Paylocity データ in RAD Studio Data Explorer

How to view Paylocity データ in RAD Studio Data Explorer using the CData ODBC Driver for Paylocity.

最終更新日：2023-06-12

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Paylocity, you gain access to live Paylocity データ within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve and update Paylocity データ. This article will walk through connecting to Paylocity using the Data Explorer.

Configure a Connection to Paylocity

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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 を設定することを意味します。

Connecting to Paylocity データ Using Data Explorer

You can create a simple application for displaying Paylocity データ by utilizing the CData FireDAC Components for Paylocity and a new VCL Forms Application:

Open the Data Explorer in RAD Studio and expand FireDAC.
Right-click the ODBC Data Source node in the Data Explorer.
Click Add New Connection.
Enter a name for the connection.
In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Paylocity.
Back in the Data Explorer, expand the tables for the connection.
Create a new VCL Forms application and drag a table (for example: Employee) onto the form.
Select the EmployeeTable object on the form and set the Active property to true.
Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).
Arrange the TStringGrid on the form and run the application to see the Employee data.