DBeaver でPaylocity のデータに接続

CData ODBC Driver for Paylocity は、ODBC 標準経由でPaylocity のリアルタイムデータにアクセスし、使い慣れた SQL クエリで各種 BI、レポート、ETL ツールからPaylocity のデータを利用可能にします。この記事では、DBeaver のクエリブラウザなどのビジュアルツールを使ってPaylocity のデータを操作する方法を解説します。

CData ODBC ドライバーは、ドライバーに組み込まれた最適化されたデータ処理により、DBeaver でのリアルタイムPaylocity データ操作において卓越したパフォーマンスを実現します。DBeaver からPaylocity に複雑な SQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされた SQL 操作を直接Paylocity にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。また、動的メタデータクエリ機能を内蔵しているため、Paylocity のデータを効率的に管理・分析できます。

Paylocity への接続設定

まだ設定していない場合は、データソース名（DSN）で必要な接続プロパティを指定します。DSN の設定は Microsoft ODBC データソースアドミニストレーターを使用して行えます。これはドライバーインストールの最終ステップでもあります。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 を設定することを意味します。

最後に、ドライバーの DSN 設定画面で「Map To WVarchar」接続プロパティを False に設定します。この設定により、文字列型が SQL_VARCHAR にマッピングされ、SQL_WVARCHAR 型が NULL として表示されるのを防ぐことができます。

DBeaver でPaylocity ODBC データソースに接続

1. DBeaver アプリケーションを開き、Database メニューから New Database Connection オプションを選択します。
2. 「Connect to a database」ウィンドウで ODBC を選択し、Next をクリックします。
3. Database/Schema フィールドに DSN 名（デフォルトでは CData Paylocity Source）を入力します。この名前は JDBC URL にも自動的に追加されます。
4. Test Connection ボタンをクリックします。DBeaver が DSN を検出すると「Connected」メッセージが表示され、接続が成功した場合はドライバーの詳細情報も表示されます。

Paylocity のデータをクエリ

これで、データソース接続から公開されているテーブルの情報をクエリできるようになりました。データベース構造を展開して、すべてのテーブルを表示できます。テーブル名を右クリックして View data を選択すると、そのテーブルのデータを取得できます。データは Data タブに表示されます。

無償トライアルと詳細情報

これで DBeaver からリアルタイムのPaylocity データに接続できました。詳細については、CData ODBC Driver のページをご覧ください。30日間の無償トライアルをダウンロードして、今すぐ DBeaver でPaylocity のリアルタイムデータを活用してみましょう。