Choreo でPaylocity とデータ連携するアプリを作成

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Choreo は、ローコードおよびクラウドネイティブなSaaS 開発のための多機能かつ包括的なプラットフォームです。 開発者は、高度なコーディングスキルがなくても、Choreo のローコード環境を利用することで簡単にアプリケーションを構築することができます。 さらにCData Connect Cloud と連携することで、アプリケーションにPaylocity のデータへのクラウドベースのアクセスを即座に追加できます。 この記事では、Connect Cloud からPaylocity に接続し、Choreo からリアルタイムPaylocity のデータにアクセスするアプリケーションを作成する方法を紹介します。

CData Connect Cloud は、Paylocity にクラウドベースのインターフェースを提供し、ネイティブにサポートされているデータベースにデータを複製することなくChoreo でリアルタイムPaylocity のデータを使用するアプリケーションを構築できるようにします。 CData Connect Cloud は最適化されたデータ処理により、サポートされているすべてのSQL 操作（フィルタ、JOIN など）をPaylocity に直接発行し、サーバー側の処理を利用して要求されたPaylocity のデータを高速で返します。

Connect Cloud からPaylocity への接続

CData Connect Cloud を使うと、直感的なクリック操作ベースのインターフェースを使ってデータソースに接続できます。

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルで「Paylocity」を選択します。
3. 必要な認証プロパティを入力し、Paylocity に接続します。

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

4. Create & Test をクリックします。
5. Add Paylocity Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

パーソナルアクセストークンの取得

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用する個人用アクセストークン（PAT）を作成できます。 きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
2. User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. 個人用アクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

接続の設定が完了したら、Choreo からPaylocity のデータに接続できるようになります。

Choreo からPaylocity への接続

以下のステップでは、Choreo からCData Connect Cloud に接続し、リアルタイムPaylocity のデータにアクセスできる新しいアプリケーションを作成する方法を紹介します。

コンストラクトを作成する

1. Choreo プラットフォームにサインインします。Note：この記事は、Anonymously を選択した場合について説明しています。
2. 左サイドバーからComponents を選択し、+Create をクリックします。次に、Manual Trigger を選択し、続けてStart from scratch を選択します。
3. マニュアルトリガーのName とDescription を入力し、Create をクリックします。
4. トリガーが作成されたら、Edit Code をクリックします。
5. Ballerina Low-Code IDE が表示されます。Choreo は、ローコードダイアグラムビューでコンストラクトを自動生成します。 このコンストラクトをハイライトしてゴミ箱アイコンをクリックし、削除します。
6. 画面上部の + アイコンをクリックし、右サイドのAdd Constructs ツールバーにあるMain を選択します。 続けてFunction Configuration フォームでSave をクリックします。

CData Connect Cloud コネクタを追加する

1. 楕円形のSTART とEND の間にある + アイコンをクリックして、Connector をクリックします。

2. 右サイドバーのConnectors で「CData」を検索します。CData Connect をクリックしてConnector 設定ペインを開きます。

3. Connector 設定ペインで、構成の設定を入力します。
   • 使用するEndpoint Name を入力します。例では「connectEndpoint」を使用しています。
   • User フィールドに、CData Connect Cloud ユーザーのE メールアドレスを引用符で囲んで入力します（例："[email protected]"）。
   • Password フィールドに、前述の生成されたPAT を引用符で囲んで入力します（例："SampleToken"）。

4. Save をクリックすると、CData Connect Cloud のロゴがついたローコードエディタが表示されます。

クエリのアクションを追加する

1. new とend の間の + アイコンをクリックし、Action を選択して既存のコネクタエンドポイントを選択します。

2. connector Operation クエリを選択します。右側にAction ペインが表示されます。

3. Paylocity のデータを取得するためのSQL クエリを、query のsqlQuery パラメータとして入力します。次に例を示します。 SELECT * FROM Paylocity1.Paylocity.Employee LIMIT 10
   • クエリを入力する際、カタログにConnection Name を、スキーマにData Source Name を必ず指定してください。例えば、Paylocity1.Paylocity です。
   • これらのパラメータはCData Connect Cloud ダッシュボードのConnections ページに表示されます。

Paylocity のデータを反復処理する

1. コードエディタの右上にあるShow Source アイコンをクリックします。
2. ballerina/io ライブラリをインポートするimport 文を追加します。

   		
   		import ballerina/io;
   	

3. 次に、SQL クエリの結果を繰り返し処理するために、query アクションの後にfrom 文を追加します。

		
		check from record{} result in resultStream
		do {
			io:println("Full Employee details: ", result);
		};
	

4. コンストラクトのコードは次のようになります。

			
			import ballerinax/cdata.connect;
			import ballerinax/cdata.connect.driver as _;
			import ballerina/io;

			public function main() returns error? {
				connect:Client connectEp = check new (user = "connect_cloud_username", password="connect_cloud_pat");

				stream<record {}, error=""?> resultStream =
				connectEp->query(sqlQuery = `SELECT * FROM Paylocity1.Paylocity.Employee LIMIT 10`);

				check from record{} result in resultStream
				do {
					io:println("Full Employee details: ", result);
				};
			}
		

5. Save をクリックしてアクションを保存します。次のようなダイアグラムになります。

プログラムをデプロイする

必要とするアクションをすべてプログラムに追加したら、次のステップに進みます。

1. Web エディタで最終的なソースコードをコミットしてプッシュし、その変更をChoreo プラットフォームに同期します。
2. Choreo Console の左ナビゲーションバーでDeploy をクリックします。
3. Build Area でConfigure & Deploy をクリックし、プログラムをデプロイします。
4. プロンプトが表示されたら、先ほど使用したCData Connect Cloud のユーザー名とパスワードを入力し、Deploy をクリックします。

Choreo でリアルタイムPaylocity のデータにアクセスできるアプリケーションを作成できました。

CData Connect Cloud の入手

Choreo をCData Connect Cloud で連携するための詳細は、CData Connect Ballerina Guide を参照してください。 CData Connect Cloud の30日間無償トライアルを利用して、クラウドアプリケーションから100を超えるSaaS、ビッグデータ、NoSQL データソースへのダイレクトなSQL アクセスをお試しください！