製品をチェック

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

 30日間の無償トライアルへ

製品の詳細

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

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

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

データ変換ツールTranSpeed でPaylocity のデータにアクセスする方法

TranSpeed でPaylocity データに連携して、CSV ファイルに出力する方法を解説します。

杉本和也
リードエンジニア

最終更新日:2023-05-12
paylocity ロゴ

CData

odbc ロゴ画像
TranSpeed ロゴ

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

TranSpeed はユーザックシステムが提供するノンプログラミングデータ変換ツールです。豊富な変換ロジックと様々なRDB、CSVファイルなどに対応しているのが特徴で、RPAツール Autoジョブ名人のデータ変換機能としても利用されています。本記事では、TranSpeed からCData ODBC ドライバを利用してPaylocity データを取得、CSV ファイルに出力する方法を解説します。

TranSpeed ではRDB の取り込み設定という仕組みが標準提供されており、この機能を介してSQL Server やMySQL などにアクセスできるようになっています。そして、この機能とCData が提供しているODBC Driver ラインナップを組み合わせることで、各種クラウドサービスのAPI にアクセスすることができるようになります。

CData ODBC ドライバとは?

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

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

CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.TranSpeed 側で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 データをTranSpeed に連携

CData Driver の設定が完了したらTranSpeed 側の設定を進めます。まずはCData ODBC ドライバ経由でPaylocity へ接続するための「データベース接続定義」を追加しましょう。

  1. TranSpeed を立ち上げて、「マッピング設定」に移動します。
  2. マッピング設定
  3. 「データベース接続定義」に移動し「新規」ボタンをクリックします。表示される画面で「新たにデータベース接続定義を作成する」を選択し「OK」をクリック
  4. データベース接続定義を作成
  5. 先程作成したODBC DSN の情報を指定した接続情報を入力します。入力後、接続テストを実行し、正常に完了したら登録ボタンをクリックして保存します。以下は接続情報の設定例です。

    プロパティ名

    設定値例

    備考

    接続名

    Paylocity

    任意の接続名を指定します。

    データベースエンジン種別

    その他

    接続方法

    Odbc

    データベース名

    Paylocity

    接続文字列

    DSN=CData Paylocity Source

    先程作成したODBC DSNの名前をDSN=以降に指定します。


    データ変換アプリケーションの作成

    ODBC の接続設定を追加したら、実際にデータ変換を行うアプリケーションを作成していきましょう。マッピング設定の画面から「システム」を選択し、「新規」ボタンをクリックします。

    アプリケーションの新規作成

    新しく作成するデータ変換アプリケーションの内容が表示されます。今回はそのままデフォルトで作成を開始します。必要に応じて各種名称を表示すると良いでしょう。

    入力データソースの設定

    アプリケーション定義画面が表示されたら、まず「入力データソース」を調整していきます。今回はPaylocity からデータを取得するので、入力データソースのデータ種別で「データベース」を選択します。データベースを選択後、データベース接続IDとして先程作成したPaylocity への接続情報を指定します。

    入力データソースの設定

    接続情報の指定が完了したら、対象となるテーブルを指定しましょう(Paylocity のEmployee など)。テーブル名を入力すると、各項目の「検索」ボタンから対象のフィールドを指定できるようになりますので、お好みのフィールドを選択してください。

    出力データソースの設定

    続いて出力データソースを設定します。今回はシンプルにCSVに出力する処理とするため、データ種別で「CSVテキスト」を選択しました

    項目定義の構成

    入力データソースと出力データソースの指定完了後、それぞれのデータソースの仲介の役割となる項目定義を追加します。

    入出力マッピングの構成

    最後に「入力データソース」「項目定義」「出力データソース」それぞれの項目を紐づける「入出力マッピング」を構成します。以下のような画面が表示されるので、それぞれの項目を紐づけていきましょう。

    入出力マッピングの構成

    これでデータ変換アプリケーションは作成完了です。

    テスト実行

    それでは作成したデータ変換アプリケーションをテスト実行してみましょう。画面左上の「テスト実行」ボタンから動作確認が実施できます。以下のような画面が表示されるので「実行」をクリックします。

    テスト実行

    正常に処理が完了すると、以下のように処理件数と完了のメッセージが表示されます。

    テスト実行結果

    CSVファイルを確認すると、Paylocity のデータをもとにしたCSV ファイルが生成されています。

    おわりに

    このようにCData ODBC ドライバを利用することで、各種クラウドサービスをTranSpeed の接続先として利用できるようになります。 CData ではPaylocity 以外にも250種類以上のデータソース向けにODBC Driver を提供しています。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

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

関連コンテンツ

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

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