Paylocity データを帳票ツールbiz-Stream で連携利用する方法

こんにちは！プロダクトスペシャリストの宮本です。

biz-Stream は、多様な表現が可能なWeb 帳票ソリューションです。

この記事では、biz-Stream からCData JDBC ドライバ経由でPaylocity データにリアルタイムで連携接続して帳票から利用する方法を紹介します。CData Drivers を使うことで、RDB のようにbiz-Stream 内でPaylocity データを扱うことができるようになります。

biz-Stream へのPaylocity JDBC ドライバーの配置

デフォルトの内容でインストールした場合、以下のパスに jar ファイルが配置されますので、その jar ファイルを biz-Stream の所定のパスにコピーします。

• cdata.jdbc.paylocity.jar
• cdata.jdbc.paylocity.lic （試用版では.lic ファイルは不要）

• コピー元：C:\Program Files\CData\CData JDBC Driver for Paylocity 20xxJ\lib
• コピー先：C:\Program Files (x86)\brainsellers\biz-Stream レイアウト・デザイナ\lib_jdbc

biz-Stream からPaylocity への接続設定

レイアウトデザイナを起動後、リソース定義にて Paylocity への接続設定を行います。ドライバー選択のプルダウンに CData Paylocity JDBC Driver が表示されますので選択します。

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

サーバURLは以下の形式で入力します。
URL: jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

JDBC Driver の接続文字列デザイナーを使う

JDBC 接続文字列を作るには、Paylocity JDBC Driver のビルトイン接続文字列デザイナーを使う方法があります。ドライバーの.jar ファイルをダブルクリックするか、コマンドラインから.jar ファイルを実行します。

Windows:

MacOS:

接続プロパティに値を入力して、生成される接続文字列をクリップボードにコピーします。

次にデータ取得条件を設定します。SQL 定義から定義名を設定し、編集ボタンをクリックします。

上のグレーエリアで右クリック → テーブルリストと選択しますと、Paylocity のオブジェクトがリストで表示されます。使用するテーブルを選択します。

ここでは取得対象の項目や条件などを設定することができます。対象項目や条件を指定できたらOKボタンをクリックし、戻った画面で追加ボタンをクリックします。

最後にデータソース設定を行います。データソース定義名に先ほど設定したものを選択し、画面下部にある追加ボタンをクリックします。これでbiz-Stream でPaylocity データを利用する準備ができました。

Paylocity データをリアルタイムで参照するbiz-Stream 帳票のデザイン

用紙設定を行います。今回は A4 設定にしました。設定後は画面下部にある追加ボタンをクリックします。

ページ設定では新規ボタンをクリックします。

ここではレイアウトデザイナが帳票テンプレートを xml で保存しますので、ファイル名を設定します。

レイアウトにはさまざまなメニューがありますが、今回は表を使用します。表を設定後、Paylocity から取得したデータをセットするエリアを作成します。各セルにテキストボックスを挿入し、そのテキストボックス自体に Paylocity の項目を紐づけします。
※ヘッダーにもそれぞれテキストボックスを追加します。

レイアウト作成画面を閉じた後、ページ設定の画面に戻りますので、画面下部にある追加ボタン（一度作成している場合は適用）をクリックし、レイアウトの作成が完了となります。

レイアウトデザイナーのトップ画面のヘッダーメニューからプレビューアイコンをクリックします。先ほど作成したレイアウトで Paylocity のデータを表示させることができます。

このようにCData JDBC ドライバをアップロードすることで、簡単にbiz-Stream でPaylocity データをリアルタイムに参照する帳票をノーコードで連携して作成することができます。

ぜひ、CData JDBC Driver for Paylocity 30日の無償評価版 をダウンロードして、お試しください。