AWS Lambda でリアルタイムPaylocity のデータにアクセス

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
CData JDBC Driver を使用して、AWS Lambda からリアルタイムPaylocity のデータに接続。

AWS Lambda は、新しい情報やイベントに素早く応答するアプリケーションを構築できるコンピューティングサービスです。CData JDBC Driver for Paylocity と組み合わせることで、AWS Lambda 関数からリアルタイムPaylocity のデータを操作できます。この記事では、Eclipse で構築した AWS Lambda 関数からPaylocity のデータに接続してクエリを実行する方法を説明します。

なお、この記事の執筆時点（2022年6月）では、AWS Toolkit for Eclipse がサポートする最新バージョンは Eclipse 2019-12 および Java 8 となっています。

最適化されたデータ処理機能を組み込んだ CData JDBC ドライバは、リアルタイムPaylocity のデータとのインタラクションにおいて卓越したパフォーマンスを発揮します。Paylocity に対して複雑な SQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を直接Paylocityにプッシュし、サポートされていない操作（主に SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。さらに、動的メタデータクエリ機能により、ネイティブのデータ型を使用して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 を設定することを意味します。

NOTE: AWS Lambda 関数で JDBC ドライバーを使用するには、ライセンス（製品版または試用版）とランタイムキー（RTK）が必要です。ライセンス（または試用版）の取得については、弊社営業チームまでお問い合わせください。

組み込みの接続文字列デザイナー

JDBC URL の構築には、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.paylocity.jar

接続プロパティ（RTK を含む）を入力し、接続文字列をクリップボードにコピーします。

AWS Lambda 関数の作成

  1. CData JDBC Driver for Paylocity のインストーラーをダウンロードし、パッケージを解凍して JAR ファイルを実行してドライバーをインストールします。

  2. AWS Toolkit for Eclipse を使用して、Eclipse で新しい AWS Lambda Java プロジェクトを作成します。詳細な手順は AWS のチュートリアル（amazon.com）を参照してください。

    この記事では、テーブル名を入力として渡せるように、プロジェクトのInput Type を「Custom」に設定します。

  3. CData JDBC Driver for Paylocity の JAR ファイル（cdata.jdbc.paylocity.jar）をビルドパスに追加します。このファイルは INSTALL_PATH\lib\ にあります。
  4. Java クラスに以下の import 文を追加します。 
    import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.Statement;

  5. handleRequest メソッドの本体を以下のコードに置き換えます。DriverManager.getConnection メソッド呼び出し内の接続文字列は、実際の値に置き換えてください。

    String query = "SELECT * FROM " + input;

try {
	Class.forName("cdata.jdbc.paylocity.PaylocityDriver");
} catch (ClassNotFoundException ex) {
	context.getLogger().log("Error: class not found");
}

Connection connection = null;

try {
	connection = DriverManager.getConnection("jdbc:cdata:paylocity:RTK=52465...;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;");
} catch (SQLException ex) {
	context.getLogger().log("Error getting connection: " + ex.getMessage());
} catch (Exception ex) {
	context.getLogger().log("Error: " + ex.getMessage());
}

if(connection != null)
{
	context.getLogger().log("Connected Successfully!\n");
}

ResultSet resultSet = null;
try
{
	//executing query
	Statement stmt = connection.createStatement();
	resultSet = stmt.executeQuery(query);

	ResultSetMetaData metaData = resultSet.getMetaData();
	int numCols = metaData.getColumnCount();

	//printing the results
	while(resultSet.next())
	{
		for(int i = 1; i <= numCols; i++)
		{
			System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null );
		}
		System.out.print("\n");
	}
}
catch (SQLException ex)
{
	System.out.println("SQL Exception: " + ex.getMessage());
}
catch (Exception ex)
{
	System.out.println("General exception: " + ex.getMessage());
}

String output = "query: " + query + " complete";
return output;

Lambda 関数のデプロイと実行

Eclipse で関数をビルドしたら、アップロードして実行する準備が整います。この記事では出力を AWS ログに書き込んでいますが、これをテンプレートとして、AWS Lambda 関数でPaylocity のデータを操作する独自のカスタムビジネスロジックを実装できます。

  1. パッケージを右クリックして、Amazon Web Services -> Upload function to AWS Lambda を選択します。
  2. 関数に名前を付け、IAM ロールを選択し、タイムアウト値を関数が完了するのに十分な値に設定します（クエリの結果サイズによって異なります）。
  3. パッケージを右クリックして、Amazon Web Services -> Run function on AWS Lambda を選択し、クエリ対象のPaylocityオブジェクト名（例：「Employee」）を入力します。
  4. ジョブの実行後、CloudWatch ログで出力を確認できます。

無償トライアル・詳細情報

CData JDBC Driver for Paylocity の30日間の無償トライアルをダウンロードして、AWS Lambda でリアルタイムPaylocity のデータを活用してみてください。ご不明な点があれば、サポートチームまでお気軽にお問い合わせください。

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

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

 ダウンロード

詳細：

Paylocity Icon Paylocity JDBC Driver お問い合わせ

Paylocity のAccounts、Envelopes、Folders データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。

この記事の内容

関連記事