RPA ツールUiPath でPaylocity データを連携利用する方法

こんにちは！リードエンジニアの杉本です。

UiPath は高機能なRPA（Robotic Process Automation）製品です。UiPath Studio を使うことで、RPA プログラムをノーコードで開発できます。CData ODBC Driver を使えば、コーディングなしでUiPath からPaylocity への接続を作成し、連携フローに組み込めます。CData ODBC Driver は、UiPath からODBC Driver に対して発行されたSQL をPaylocity へのリアルタイムリクエストに変換し、レスポンスをテーブルデータとして取得します。

この記事では、UiPath Studio を使ってPaylocity に連携するRPA プログラムを作成します。

今回作成するUiPath RPA プロジェクト

データベース接続用アクティビティを利用してCData ODBC Driver for Paylocity に接続し、Paylocity のEmployee データを取得するSQL を実行。取得したデータをCSV 書き込みアクティビティを利用して、CSV 出力するRPA プロジェクトを作成します（以下は完成したフローチャート）。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Paylocity をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにPaylocity データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.UiPath 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとPaylocity への接続設定

まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

インストール後、ODBC DSN Paylocity で接続プロパティを設定します。Microsoft ODBC Data Source Administrator を使用して、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 を設定することを意味します。

これで、UiPath Studio にPaylocity データを接続する準備は完了です。では、実際にプロジェクトを作成していきましょう。

1. スタートページから「プロセス」をクリックして、新しいプロジェクトを作成します。
2. プロジェクトを作成したら、「新規」アイコンから「フローチャート」を選択して、新しいフローチャートを作成します。
3. Paylocity への接続を行うには、データベース接続用のアクティビティが必要になります。リボンの「パッケージを管理」をクリックし、「UiPath.Database.Activities」を検索してインストールしてください。

データ取得用アクティビティの作成

データベース関連のアクティビティが追加できたので、次にPaylocity への接続を設定してデータを取り出すための、「クエリを実行」アクティビティを追加します。

1. アクティビティナビゲーションから「クエリを実行」を選択し、フローチャートに配置します。
2. アクティビティをダブルクリックすると設定用画面に移動するので、「接続を構成」をクリックします。
3. 「接続ウィザード」をクリックして、「Data Source」に「Microsoft ODBC Data Source」を選択します。
4. 「Use user or system data source」のドロップダウンから、先ほど作成した「CData Paylocity Source」を選択します。
5. 「Test connection」をクリックして接続テストが成功したら、OK をクリックします。これで、UiPath からPaylocity への接続設定は完了です。
6. 次に、データ取得用のクエリを入力します。以下はサンプルのSQL です。

"SELECT * FROM Employee;"

7. 最後に、「クエリを実行」アクティビティのプロパティにある「出力」以下の、データテーブルの「＋」ボタンから、出力格納用の変数を作成します。

CSV 書き込み用のアクティビティを作成

最後に、出力したデータをCSV に書き込むためのアクティビティを作成します。アクティビティの設定画面から以下の項目を指定してください。

• 書き込み元：先ほど作成した出力用変数を指定します。
• 書き込み先ファイル：任意のファイルパスを指定します。右側のフォルダアイコンからGUI ベースで指定できます。

各アクティビティの紐づけと実行

あとは各アクティビティを紐付ければ、Paylocity データを出力するRPA プロジェクトの作成は完了です。

リボンから「実行」を選択してクリックすると、フローが実行されます。無事、Paylocity データを持ったCSV ファイルが作成されていました！もちろん取得したデータは、CSV 作成以外にもさまざまなフローに組み込んで使用できます。

おわりに

このようにCData ODBC ドライバを利用して、簡単にUiPath Studio でPaylocity に連携するフローを作成することができました。CData ではPaylocity 以外にも270種類以上のデータソース向けのドライバーを提供しています。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData ODBC ドライバは、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。