接続の設定

コネクタのインストール後、Paylocity 内のデータのデータソースに接続して作成できます。

データソースの設定

データに接続するには、次の手順を実行してください：

接続 | To a Server で詳細をクリックします。
Paylocity by CData というデータソースを選択します。
接続に必要な情報を入力します。
サインインをクリックします。
必要に応じて、データベースおよびスキーマを選択して利用可能なテーブルとビューを確認できます。

Connection Builder の使用

connector は、代表的な接続プロパティをTableau 内で直接利用できるようにします。しかし、より高度な設定が必要な場合や接続に関するトラブルシューティングが必要な場合には、使いにくいことがあります。 connector には、Tableau の外で接続を作成してテストできる、独立したConnection Builder が付属しています。

Connection Builder にアクセスする方法は2つあります。

Windows では、スタートメニューのCData Tableau Connector for Paylocity フォルダの下にあるConnection Builder というショートカットを使用します。
また、ドライバーのインストールディレクトリに移動し、lib ディレクトリで.jar ファイルを実行することによってもConnection Builder を開始できます。

Connection Builder では、接続プロパティに値を設定し、接続テストをクリックしてその動作を確認できます。また、クリップボードにコピーボタンを使用して、接続文字列をコピーすることもできます。この接続文字列は、Tableau 内のconnector 接続ウィンドウにあるConnection String オプションに指定できます。

Paylocity への接続

Paylocity は、Pay Entry API 経由と標準のPaylocity API 経由の2つの接続方法を提供します。

接続する前に、次のプロパティを設定します（該当する場合）。

サンドボックスアカウントを使用する場合はUseSandbox をtrue に設定し、そうでない場合はfalse に設定します。
IncludeCustomFields がtrue の場合、CustomFieldsCategory をCustomfields カテゴリに設定します。デフォルト値はPayrollAndHR です。

暗号化をオプトインしているサイトの場合：

次の暗号化プロパティのいずれか1つだけを設定してください。
- Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。この鍵はPaylocity コンテンツの暗号化に使用されます。Paylocity はRSA 復号化を使用してAES 鍵を復号化します。
  IV 値が指定されていない場合に使用されます。
- IV：Paylocity を暗号化するときに使用するAES IV（base 64 エンコード）。Key 値が提供されない場合は、IV は内部的に生成されます。
Paylocity アカウントでRSA 暗号化が有効になっている場合は、RSAPublicKey をPaylocity に関連付けられたRSA キーに設定します。（このプロパティは、Insert およびUpdate ステートメントを実行する場合は必須です。）この機能が無効になっている場合は必須ではありません。

Pay Entry API

Pay Entry API は、個々の従業員の給与情報を自動的に提出することを可能にする、極めて限定的な接続であり、それ以外のことはほとんどできません。Pay Entry API で提供されるものは極めて限定されているため、独立したスキーマはありません。しかし、UsePayEntryAPI 接続プロパティで有効にすることができます。

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。

UsePayEntryAPI をtrue に設定する場合は、以下のストアドプロシージャのみ利用できることに注意してください。

CreatePayEntryImportBatch
MergePayEntryImportBatch
Input_TimeEntry
利用可能なOAuth ストアドプロシージャ

製品のその他の機能を使用しようとするとエラーが発生します。

また、Pay Entry API で使用するために取得したOAuthAccessToken は、別途保存する必要があります。このため、この接続プロパティを使用する際には、別のOAuthSettingsLocation の設定が必要になることがよくあります。

Paylocity への認証

Paylocity は、Pay Entry API または標準のPayloticity API からのデータへのすべての接続でOAuth 認証をサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの最も一般的な認証フローでのPaylocity への認証について詳しく説明します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。 Paylocity で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

デスクトップアプリケーション

カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ：

InitiateOAuth = GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。
CallbackURL = アプリケーションの登録時に定義されたリダイレクトURI。

接続すると、connector はデフォルトブラウザでPaylocity のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

アプリケーションにアクセス許可を与えると、connector はOAuth プロセスを完了します。

connector はPaylocity からアクセストークンを取得し、それを使ってデータをリクエストします。
OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます。

アクセストークンの期限が切れたときは、connector は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

connector がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

はじめてデータに接続する前に、次の接続プロパティを設定します。
- InitiateOAuth = REFRESH。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
- OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation = connector がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

次のステップ

データビジュアライゼーションを作成するには、コネクタの使用を参照してください。

Tableau Connector for Paylocity