業務アプリ構築ツールコンテキサーで、Paylocity と連携したアプリを作成する方法

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

コンテキサーとは、株式会社アプストウェブが提供する業務アプリケーションを構築のための純国産ノンプログラミング開発ツールです。CSVファイルやクラウドデータベース、ODBC 経由でのRDBのデータをもとに、ノンプログラミングで様々な業務アプリケーションを短時間で開発できるのが特徴です。

コンテキサーではRDBと連携する仕組みが標準提供されており、この機能を介してSQL ServerやMySQLなどにアクセスできるようになっています。そして、この機能とCData ODBC Driver for Paylocity を組み合わせることで、各種クラウドサービスのAPIにアクセスすることができるようになります。

CData ODBC ドライバとは？

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

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

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

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

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

インストール後、ODBC DSN（データソース名）で接続プロパティを設定します。これはドライバーのインストールの最後の手順にあたります。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 を設定することを意味します。

Paylocity データをコンテキサーに連携

以下の手順で、コンテキサーでのアプリ作成を進めます。

1. アプリを作る前に、データベースへの接続情報を追加します。「データ」タブから「データベース」をクリックします。
2. 以下のようにデータベース接続設定を追加する画面が表示されるので、「新規」ボタンをクリックし、先程作成したODBC 接続のDSN 名を入力します。
3. エンジンはCData Driver と相性の良いMySQL ベースで指定します。それ以外のサーバやデータベースなどの情報は指定不要です。
4. 接続確認を行い、「接続に成功しました」というメッセージが表示されればOKです。「登録」をクリックしてデータベース接続情報を保存しましょう。

パネルの追加

データベース接続情報の追加が完了したら、アプリを作成していきます。今回はシンプルにPaylocity の一覧を表示するアプリを作成します。

1. 「定義」→「パネル追加」で「データベースから」を選択し、先程のDSN名でテーブルを一覧から選択します。今回はPaylocity のEmployee を指定しました。
2. 「読み込みする」ボタンをクリックします。
3. パネルのフォーマットは任意ですが、今回は新しいシートに表形式で追加しました。
4. これで以下のようにパネルが展開され、ODBC を経由してPaylocity のデータがシームレスに読み込まれました！

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコンテキサーからコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

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