インテリジェントオートメーションRPA、Blue Prism でPaylocity データを連携利用

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

Blue Prism は2001年にイギリスで創業したBlue Prism 社が提供するエンタープライズ企業向けのロボティック・プロセス・オートメーション（RPA）ツールです。

大きな特徴は「プロセス」と「オブジェクト」という概念で自動化処理を構成していくところが挙げられるでしょう。あらかじめ各種アプリケーションを操作する手続き、振る舞いをオブジェクトとして定義することで、再利用性を高め、全体の開発生産性を向上させています。

このオブジェクトはVBO という名前で各種テンプレート、プリセットが公開されており、初心者でもさまざまなアプリケーションやローカルファイル、サービスなどに接続することが可能になっています。

そんなVBO の中にはODBC 経由でデータベースに接続できるものも提供されており、CData ODBC ドライバと組み合わせることで、CData が対応しているさまざまなデータソースと手軽に連携ができるようになります。

今回の記事ではこのODBC 用のVBO とCData ODBC ドライバを使って、Blue Prism からPaylocity に接続する方法を紹介します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

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

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

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

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

1. まずODBC DSN に必要な接続プロパティの値を入力します。 組み込みのMicrosoft ODBC データソースアドミニストレーターを使用してDSN を構成できます。 これは、ドライバーのインストール時の最後のステップでも可能です。 Microsoft 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 を設定することを意味します。

2. 入力後、接続テストが成功すれば設定は完了です。

ODBC 用の VBO を追加する

続いて、ODBC 用のVBO をBlue Prism に追加しましょう。

1. こちらのURLから「Connector for ODBC Utility Blue Prism」が入手できます。
2. 「BPA+Object+-+Data+-+ODBC+v1.0.xml」というXMLファイルがダウンロードできるので、Blue Prism を立ち上げてオブジェクトとしてインポートしましょう。
3. 対象のファイルを選択し「次へ」進みます。
4. インポートが完了すると、以下のようにオブジェクト一覧に「Data - ODBC」が追加されます。
5. これを使って、CData ODBC ドライバへ Blue Prism から簡単に接続できるようになります。

新しいプロセスを作成する

それでは早速自動化のプロセスを作成していきましょう。

1. 「新しいプロセスまたはビジネスオブジェクト」から「プロセス」を選択して、次へ進みます。
2. 任意のプロセス名を入力します。
3. 必要に応じてプロセスの説明を指定して、「終了」をクリックしましょう。
4. これで以下のように初期化されたプロセスが立ち上がります。

ODBC Open 処理を追加する

ODBC の接続処理は以下の3つのプロセスで実施します。実際にデータの操作を実行するのは真ん中の部分ですが、前後の処理が必要になるという点に注意してフローを組みましょう。

• コネクションを確立するためのOpen 処理
• SQL やINSERT 文などを実行するExecute（ExecuteNonQuery）処理
• コネクションを終了するためのClose 処理

まずは「コネクションを確立するためのOpen 処理」を追加します。

1. 「アクション」を画面に配置して設定画面を開きます。
2. ビジネスオブジェクトの一覧から先ほどインポートした「Data - ODBC」を選択しアクションの一覧で「Open」を選択しましょう。
   「Open」アクションは入力パラメータとして「Connection String」を必要とします。ここで先ほど設定したCData ODBC ドライバのDSN 名を「"DSN=CData Paylocity Source"」といった形式で指定します。

ODBC 経由でデータを取得する処理を追加する

続いてPaylocity からデータを取得する処理を追加していきましょう。

1. 先ほどと同じように「アクション」を追加し
2. ビジネスオブジェクトの一覧から「Data - ODBC」を選択、アクションの一覧で「Execute」を選択しましょう。Execute ではSQL を指定して、データを取得することができます。
3. なお、SELECT Statement で利用するテーブルやカラムの情報はODBC DSN の「テーブル」タブから確認できます。
4. また、Blue Prism 上で取得した結果を扱えるように、処理結果を変数に格納します。出力タブにある「Results」の変数アイコンをクリックして、出力先の変数を生成し「OK」をクリックしましょう。

ODBC のクローズ処理を追加する

最後にODBC の処理を終了して、接続を開放するためにクローズ処理を追加します。

1. 同じようにアクションを配置し
2. ビジネスオブジェクトの一覧から「Data - ODBC」、アクションの一覧で「Close」を選択しましょう。Close では特に設定するパラメータはありません。
3. 最後にリンクを繋いで、以下のようなプロセスができ上がります。

Excel に保存する処理を追加する

これだけではデータを取得して何も行わないので、Excel ファイルに書き込みを行ってみましょう。「Excel VBO」を使って、後続のフローを作成します。

1. 以下のようなフローで作成しています。
2. 「MS Excel VBO::Write Collection」のアクションで入力パラメータの「Collection」にODBC 経由で取得した「Results」を書き込んでいます。

動作確認

プロセスが完了したら「実行」ボタンをクリックして、実際に動かしてみましょう。

1. 画面左上の実行ボタンをクリックします。
2. 最終的に以下のようなExcel ファイルに書き込みが完了していればOK です。

このようにCData ODBC Driver for Paylocity とBlue Prism を組み合わせることで、簡単にPaylocity データを活用したフローを作成することができました。ぜひ、30日の無償評価版 をお試しください。