Unqork でPaylocity に接続されたアプリケーションを作成

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

概要

CData Connect Cloud を使えば、Unqork からPaylocity データを取得できます。そのデータを使って、カスタムの業務アプリケーションをドラッグドロップ操作で作成できます。この記事ではそのための手順を説明します。

Unqork はあらゆる操作を視覚的に実行できるノーコードの開発プラットフォームで、大企業の複雑なカスタムソフトウェア作成を支援します。CData Connect Cloud はPaylocity をREST エンドポイントとして公開するので、Unqork 側で簡単なHTTP リクエストを使ってクエリできます。この方法で、Paylocity データを使ったカスタムアプリケーションを作成できます。

この記事を読んでわかること

本記事では、次の点について説明します。

• CData Connect Cloud のユーザーを追加する方法。
• Connect Cloud ユーザー用のパーソナルアクセストークンを追加する方法。
• Connect Cloud からPaylocity に接続する方法。
• Connect Cloud にPaylocity OData エンドポイントを追加する方法。
• Connect Cloud 経由でPaylocity をUnqork サービスとして登録する方法。
• Paylocity データを表示するための簡単なUnqork アプリケーションを作成する方法。

CData Connect Cloud を構成する

Unqork からPaylocity データを扱うには、以下の手順が必要です。

• CData Connect Cloud からPaylocity に接続。
• CData Connect Cloud で新しいコネクションにユーザーアクセス権限を追加。
• Paylocity データのOData エンドポイントを作成。

（オプション）新しいConnect Cloud ユーザーを追加

必要な際には、Connect Cloud 経由でPaylocity に接続するユーザーを作成してください。

1. Users ページに移動して、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
3. Users ページからユーザーを確認、変更できます。

パーソナルアクセストークンを追加する

OAuth 認証をサポートしないサービス、アプリケーション、プラットフォーム、フレームワークから接続する場合、パーソナルアクセストークン（Personal Access Token, PAT）を認証に使用できます。きめ細かくアクセスを管理するために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
2. PAT の名前を入力して Create をクリックします。
3. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect Cloud からPaylocity に接続する

CData Connect Cloud は直感的なクリック操作ベースのインターフェースを使ってデータソースに接続します。
1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルから「Paylocity」を選択します。
3. 必要な認証情報を入力し、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 を設定することを意味します。

4. Create & Test をクリックします。
5. Add Paylocity Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にPaylocity のOData エンドポイントを追加する

Paylocity に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動して、 Add をクリックそ新しいOData エンドポイントを作成します。
2. Paylocity のコネクション（例：Paylocity1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、Confirm をクリックします。

OData フィードのサンプルURL

Paylocity への接続を構成してユーザーを作成し、Connect Cloud でOData エンドポイントを作成すると、Paylocity データのOData フィードにアクセスできるようになります。 以下は、テーブルにアクセスするためのURL とテーブルのリストです。テーブルへのアクセスについては、Connect Cloud のOData ページを参照してください。 URL はConnect Cloud のものが必要です：https://cloud.cdata.com/api/odata/service。

テーブル		URL
エンティティ（テーブル）一覧		https://cloud.cdata.com/api/odata/service/
メタデータ		https://cloud.cdata.com/api/odata/service/$metadata
Employee		https://cloud.cdata.com/api/odata/service/Employee

通常のOData フィードについては、返されるフィールドを制限したい場合は、クエリに$select パラメータと$filter、$orderby、$skip、$top といった他の一般的なOData URL パラメータを組み合わせて追加できます。 サポートされているOData クエリの詳細についてはヘルプドキュメントを参照してください。

コネクションとOData エンドポイントを設定したら、Unqork からPaylocity データに接続できます。

Paylocity データを使った簡単なアプリケーションを作成

Connect Cloud でPaylocity のREST API を設定したら、Paylocity に接続したアプリケーションをUnqork で作成できます。以下がそのための基本的な手順です。

• Paylocity をUnqork サービスとしてConnect Cloud 経由で登録
• Unqork 内にワークスペースを作成
• module-type のアプリケーションを作成

Paylocity をUnqork サービスとしてConnect Cloud 経由で登録

Connect Cloud に接続するには、ご利用の環境に外部サービスへの接続権限を付与する必要があります。Services Administration から付与を実行してください。

1. Unqork Designer Platform の右上端にある、Settings ドロップダウンメニューをクリックします。
2. Administration をクリックします。
3. Integrations 以下の、Services Administration をクリックします。
4. Service Title を入力します。例えば、Connect Cloud。
5. Service Name を入力します。例えば、cdataConnect。
6. Service protocol + host を入力します。これは参照したいAPI エンドポイントのことです。例えば、 https://cloud.cdata.com/api/odata/service。
7. Type of Authentications ドロップダウンメニューからBasic Auth を選択します。
8. Connect Cloud のユーザーID（例：user@mydomain.com）をUser Name フィールドに入力します。
9. Connect Cloud のユーザーのPAT をPassword フィールドに入力します。
10. Add Service をクリックします。

Workspace を作成する

Unqork では自身のワークスペースを作成することができ、それが自身やチームがアプリケーションを保存したり整理したりする仮想コンテナとなります。ワークスペースを作成したら、そこにアプリケーションを追加できます。

ワークスペースを作成するには、以下の手順を実行します。

1. Create Workspace をクリックします。
2. 一意のWorkspace Name を入力します。
3. Create をクリックします。

作成したワークスペースタイルがWorkspaces タブ以下に表示されます。

Module-Type のアプリケーションを作成する

ワークスペースを追加したら、アプリケーションを作成できます。module-type もしくはworkflow-type のアプリケーションを選択できます。今回の例では、module-type のアプリケーションを作成します。

1. 開いたワークスペースからApps に移動します。
2. Create Workspace をクリックします。
3. 一意のApp Name を入力します。
4. Style ドロップダウンメニューからプレビュースタイルを選択します。スタイルはアプリケーションの外観を指定します。空白にした場合は、アプリケーションは環境のデフォルトスタイルを使用します。
5. App Type ドロップダウンメニューからModule を選択します。
6. App Entrypoint Module ドロップダウンメニューからNew Entrypoint Module を選択します。
7. Create をクリックします。

新しいアプリケーションのModules タブに移動します。次のように表示されます。

モジュールに名前をつけるには、Module Editor でタイトルをクリックします。

アプリケーションの作成を完了するには、次のコンポーネントが必要です。

• Hidden コンポーネント：Plug-In で取得したデータを格納します。
• Initializer コンポーネント：テーブルを表示する際にPlug-In を実行します。
• Plug-In コンポーネント：Connect Cloud からPaylocity データを取得してHidden コンポーネントに格納します。
• ViewGrid コンポーネント：Hidden コンポーネントに格納したデータからHTML テーブルを作成します。

Hidden コンポーネントを設定する

Hidden コンポーネントはConnect Cloud から取得したPaylocity データを格納します。

1. Hidden コンポーネントをキャンバスにドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。
   

   NOTE：Property ID はキャメルケース（camelCase のように）にする必要があります。例えば、hiddenComponent です。Hidden コンポーネントユーザーには表示されないので、Property ID をCanvas Label Text として使用してください。

3. Save をクリックします。

Plug-In コンポーネントを設定する

次に、Connect Cloud にデータをリクエストするためのPlug-In コンポーネントを追加します。このコンポーネントは、Service Administration で設定したサービスに接続します。

1. Plug-In コンポーネントを、キャンバスのHidden コンポーネントの下にドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。Plug-In のProperty ID はplugin で始めるのがベストプラクティスです。例えば、pluginGetAWProducts。

3. Outputs テーブルを次のように設定します。
   • Hidden コンポーネントのProperty ID をProperty ID カラムに入力します。
   • value をMapping カラムに入力します。
4. Service Type としてExternal を選択します。
5. External Services ドロップダウンメニューから、Connect Cloud サービスを選択します。これは、Services Administration で設定した外部サービスです。
6. Data Sources URL の最後にConnect Cloud リソースの特定のエンドポイントを追加します。例えば、AdventureWorks2012_Production_Product です。

   NOTE：データソースのURL は、https://cloud.cdata.com/api/odata/service/AdventureWorks2012_Production_Product と類似の値となります。

7. Save をクリックします。

Initializer コンポーネントを設定する

Initializer コンポーネントは、Paylocity データを取得するPlug-In を実行するためのものです。

1. Initializer コンポーネントを、キャンバスのPlug-In コンポーネントの上にドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。Initializer のProperty Name はinit で始めるのがベストプラクティスです。例えば、initGetAWProducts です。
   

3. Trigger Type としてNew Submission を設定します。
4. Outputs テーブル内に次を入力します。
   • Plug-In のProperty ID をProperty ID カラムのフィールドに入力します。
   • Type カラムのフィールドにtrigger と入力します。
   • Value カラムのフィールドにGO と入力します。
5. Save をクリックします。

ViewGrid コンポーネントを設定する

ViewGrid コンポーネントはHidden コンポーネントに格納されたデータを参照します。その後、ダッシュボード（またはテーブル）にPaylocity データを表示します。

1. ViewGrid コンポーネントを、キャンバスのPlug-In コンポーネントの下にドラッグドロップします。
2. Label とProperty Name を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。ViewGrid のProperty Name はvg で始めるのがベストプラクティスです。例えば、vgAWProductView です。

3. Inputs テーブルで、id をHidden コンポーネントのProperty ID に設定します。
4. Display テーブルで次を設定します。
   • id カラム内に、表示したいフィールドのID を入力します。
   • handing カラムに、各フィールド用のタイトルを入力します。フィールドは、自身とユーザーに次のように表示されます。
5. Save をクリックします。
6. Save ボタンでモジュールを保存します。

上のコンポーネントを追加、設定したら、アプリケーションの自身とユーザーへの表示をプレビューできます。Module Editor で、Preview Module をクリックしてモジュールの前からの表示（"Express View"）を確認できます。

Express View モジュールは次のように表示されます。

詳細と無料トライアル

Connect Cloud とUnqork を組み合わせれば、Paylocity に接続できるアプリケーションを簡単に作成できます。Connect Cloud の無償トライアルを始めてUnqork からすぐにPaylocity データにアクセスしましょう。