製品をチェック

Paylocity ODBC Driver の30日間無償トライアルをダウンロード

 ダウンロードはこちら

製品の詳細

Paylocity アイコン Paylocity ODBC Driver 相談したい

Paylocity ODBC Driver を使って、ODBC 接続をサポートする多様なツールからPaylocity にデータ連携。

DB のようにPaylocity データへODBC インターフェースでアクセス可能に。

Paylocity データにSQL Server のリンクサーバーとして接続する方法

ODBC Driver のSQL Gateway 機能を使ってPaylocity のリンクサーバーをセットアップ。

兵藤朋代
コンテンツスペシャリスト

最終更新日:2023-09-07
paylocity ロゴ

CData

odbc ロゴ画像
SQL Server ロゴ

こんにちは!ドライバー周りのヘルプドキュメントを担当している兵藤です。

本記事では、SQL Server のTDS Remoting 機能を使ってPaylocity のリンクサーバーをセットアップする方法をご紹介します。リンクサーバーの利用には、CData ODBC Driver に同梱されているSQL Gateway を使用します。 SQL Server のインターフェースでPaylocity への読み書き双方向のアクセスが可能になります。

Paylocity リンクサーバー利用シナリオ

  • SQL Server に接続しているアプリケーションでPaylocity データを利用したいがデータ接続を増やしたくない
  • Paylocity データをSQL Server のデータや他のリンクサーバーのデータをJOIN などして使いたい
  • 利用したいミドルウェア・BI ツールなどにODBC やJDBC の汎用のインターフェースがないが、SQL Server には接続できる

Paylocity DSN の設定

まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。ODBC ドライバーのインストール完了時に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 を設定することを意味します。

SQL Gateway でのPaylocity ODBC DSN を設定

CData ODBC Drivers にはSQL Gateway が同梱されています。このSQL Gateway に、Paylocity ODBC Driver をサービスとして設定します。

  1. 「スタート」画面から「SQL Gateway」を起動します。青い「C」のSQL Gateway ロゴが右下のインジケータに表示されます。 アプリケーションコンソールが開かない場合には、SQL Gateway アイコンを右クリックして、「Open Application」をクリックしてください。
  2. アプリケーションコンソールの「Service」タブを開いて、「Add」をクリックして、新しいODBC データソースを設定します。
  3. Paylocity ODBC の設定を行います。
    Service Name]:任意
    リモーティングDB 選択:SQL Server を選択
    Data Source:ドロップダウンでCData Paylocity Source Sys を選択
    Port:使用していないポートを選択
    Setting ODBC Driver
  4. 次に「Users」タブ→「Add」からユーザーを登録します。
    ユーザー毎にFull アクセスか、Readonly か、None の権限を選択できます。
    複数のODBC データソースがある場合には、データソース毎に権限の設定が可能です。
    User setting
    「OK」を押して、ユーザー登録を完了します。 その後「Save Changes」で設定を保存します。
  5. SQL Gateway の「Service」タブで「Start」ボタンを押して、サービスを起動します。サービスの左側の〇が緑色になれば、サービスは起動中です。

SQL Server でPaylocity リンクサーバーを設定

SQL Gateway 側でサービスの設定が終わったら、SQL Server 側でPaylocity サービスをリンクサーバーとして使う設定をしましょう。

  1. SQL Server Management Studio (SSMS) を開きます。
    オブジェクトエクスプローラーの「サーバーオブジェクト」で「リンクサーバー」を右クリックして、「新しいリンクサーバー」をクリックします。
  2. 新しいリンクサーバーの設定画面の「全般」で、以下を入力します。
    サーバー種類:その他データソース
    プロバイダー:SQL Server Native _Client 11.0
    データソース:この例の場合、localhost, 1433 を入力
    カタログ:ODBC DSN 名を入力
    Linked Server setting
  3. また、「セキュリティ」では、「このセキュリティコンテキスト」を選択して、リモートログインにSQL Gateway にユーザー設定したUser 名とPassword を入力します。

これで、リンクサーバーの設定は終わりなので、「OK」を押して設定を保存します。

SSMS でデータを見てみる

SSMS のオブジェクトエクスプローラーのリンクサーバー下にPaylocity のリンクサーバーが作成され、「テーブル」下にPaylocity のデータがアプリ単位でテーブルが生成されます。
新しいクエリを選択し、Paylocity データを取得してみます。

SELECT * from リンクサーバー名.CData Paylocity Source Sys(ODBC DSN 名).Paylocity.テーブル名

このように、API のリクエストではなく通常のSQL 構文でデータを扱うことが可能になっています

Visual Studio からPaylocity リンクサーバーを使う

Visual Studio のサーバーエクスプローラーの「データ接続」を右クリックし、「接続の追加」をクリックして、データソースの選択画面を開きます。 データソースの選択画面でデータソースを「Microsoft SQL Server 」に選択して、「続行」を押します。

「接続の追加」画面で、以下を入力します。
サーバー名:SQL Server のサーバー名
認証:任意の認証方式
データベース名の選択または入力:※master など
※リンクサーバーを直接データベース名として入力することはできないようです。なので上位のデータベース名で設定しておきます。

リンクサーバー設定

「テスト接続」をして大丈夫であれば、「OK」を押して設定を完了させます。

「新しいクエリ」で、SQL でSELECT 文を書いてデータを取得してみます。

SELECT * from リンクサーバー名.CData Paylocity Source Sys(ODBC DSN 名).Paylocity.テーブル名

このように、通常のSQL Server のリンクサーバーと同じようにVisual Studio 内Paylocity データを扱うことが可能になります。 他のIDE でもSQL Server にアクセスする方法でPaylocity データにSQL でアクセスが可能になります。
複数データソースのJOIN などを行う場合には大変便利です。

おわりに

このようにCData ODBC Drivers と併用することで、270を超えるSaaS、NoSQL データをSQL Server に連携できます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。