製品をチェック

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

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

製品の詳細

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

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

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

Claris FileMaker のESS 機能からPaylocity のデータに連携する方法

Claris FileMaker の外部SQL データソース(ESS)機能とCData ODBC ドライバを使って、Paylocity のデータとシームレスに連携する方法を紹介します。

桑島義行
テクニカルディレクター

最終更新日:2024-01-12
paylocity ロゴ

CData

odbc ロゴ画像
FileMaker ESS ロゴ

こんにちは!テクニカルディレクターの桑島です。

この記事では、Claris FileMaker の外部SQL データソース(ESS)機能とCData ODBC ドライバを利用して、Paylocity のデータにシームレスに連携する方法を紹介します。

FileMaker とPaylocity のデータを連携する3つの方法

FileMaker からPaylocity と連携するには大きく3つの方法があります。本記事では③の方法を解説しますが、①や②の方法を解説する記事も用意していますので、必要に応じて参照してください。

  1. ODBC インポート機能を活用:ODBC プロトコルを活用してFileMaker にデータを取り込みます。最も簡単な方法ですが、データに変更があった場合に全件再取り込みが必要になります。定期的にデータを更新する場合には、②の方法がベターです。詳しくはこちらの記事をご確認ください。
  2. スクリプト機能を活用:FileMaker に搭載されているスクリプト機能を活用することで、初回だけ全件データを取り込み、その後は変更のあったデータだけを取り込む差分更新でデータを更新できます。詳しくはこちらの記事をご確認ください。
  3. ESS(External SQL Source)機能を活用:本記事で解説する方法です。ESS はFileMaker から外部データソースにリアルタイム接続できる機能です。接続設定は少し面倒ですが、ESS ではリアルタイム接続が可能なので、データ変更をすぐに反映したい、という場合にはベストな方法です。

FileMaker のESS 機能とは?

FileMaker のESS 機能は、FileMaker から外部データソースにリアルタイムで接続できる機能です。ただし、ネイティブで使用できるODBC Driver はFileMaker 側がサポートしているドライバーのみであり、CData ODBC ドライバのような任意のサードパーティドライバーを使用することができません。

SQL Gateway でESS のデータソースを拡充

そこで今回は、CData ODBC ドライバをMySQL に仮想化してアクセスできるようにするSQL Gateway という機能を活用します。この機能を使うことで、FileMaker のESS 側ではデフォルトのMySQL ODBC Driver を使いつつ、SQL Gateway 経由でPaylocity のデータに連携することが可能となります。

ちなみに、リアルタイム連携ではなくインポートだけの処理であれば、ESS やSQL Gateway を使わなくてもサードパーティODBC のデータをインポートすることが可能です。詳しくはODBC でPaylocity のデータをFilemaker にインポートの記事を参照してください。

CData ODBC ドライバとは?

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

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

CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.Claris FileMaker 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとPaylocity への接続設定

まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

インストールが完了したら、Paylocity との接続設定を進めていきましょう。

インストール後自動的にPaylocity DSN の設定画面が表示されるので、必要な接続プロパティを取得・設定していきます。

ODBC DSN に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 を設定することを意味します。

SQL Gateway でPaylocity ODBC のサービスを設定

次にSQL Gateway で上の手順で作成したPaylocity ODBC DSN をMySQL サービスとして公開します。

  • CData ODBC ドライバをインストールしたWindows マシンのプログラムメニューから「CData SQL Gateway」を起動します。
  • 起動するとCData SQL Gateway のコンソールが開きます。「サービス」タブを開き、「追加」ボタンをクリックします。「新規サービスの追加」ダイアログが表示されるので以下の項目をセットします。
    • サービス名:任意(アルファベットでスペースなどの特殊文字系は含めないのが望ましい、本例では「CData」)
    • 選択(TDS(SQLServer)、MySQL)ラジオボタン:「MySQL」を選択
    • データソース :CData ODBC ドライバのシステムDSN 名を選択(本例では、CData Paylocity Sys)
    • ポート:同マシンにMySQL が既に起動している場合は、デフォルトの3306が既に利用されているので本例では「3307」を指定
    SQL Gateway のサービス設定。
  • 「OK」ボタンをクリックして「新規サービスの追加」ダイアログを閉じ、上記で設定したサービスが追加されたのを確認します。
  • SQL Gateway のサービスの登録を確認。
  • 「ユーザー」タブを開き、「追加」ボタンをクリックします。「新規ユーザーの追加」ダイアログが表示されるので任意の名称で「ユーザー」および「パスワード」を設定します。本情報が、仮想MySQL へのログイン情報となりますので手元に控えておいてください。
  • SQL Gateway のユーザーを作成。
  • 「サービス」タブに移動して上段メニューの「変更を保存」、その後に「開始」ボタンをクリックします。仮想MySQL インスタンスが起動するとサービス名左横のランプが緑になります。
  • SQL Gateway のPaylocity サービスを稼働。

Claris Filemaker のESS からPaylocity に連携

それでは、ESS からPaylocity に連携していきましょう。MySQL Driver のインストールからはじめます。

MySQL ODBC Driver のインストールと設定

  • MySQL ODBC 8.0 Unicode Driver の64bit Windows版をダウンロードしてインストールします。
  • インストールが完了したら、Windows の検索から「odbc」と入力して「ODBCデータソース (64bit)」を起動します。
  • 「システムDSN」タブを開き、「追加」ボタンから「データソース の新規作成」にて「MySQL ODBC 8.0 Unicode Driver」を選択して「完了」ボタンをクリックします。
  • MySQL ODBC Driver のDSN を追加。
  • 「MySQL Connector/ODBC Data Source Configuration」が起動して以下の項目をセットします。
    • Data Souce Name : 任意の名称(本例では、「CData」)
    • TCP/IP Server : CData SQL Gateway の仮想MySQL が起動しているマシンのIP アドレス(同一マシンの場合は「localhost」)
    • Port : SQL Gatewayで設定したポート(本手順では「3307」を使用)
    • User : SQL Gatewayで設定したユーザー名
    • >Password : SQL Gateway で設定したユーザーのパスワード
    • Database : ドロップダウンリストからCData ODBC ドライバのDSN 名称「CData Paylocity Sys」を選択
  • MySQl ODBC にSQL Gateway への接続を設定。
  • 「Test」ボタンをクリックして「Connection Successful」ダイアログが表示されることを確認してダイアログ含め「OK」ボタンで保存して「ODBC データソース アドミニストレーター(64ビッド)」ウィンドウまで閉じてください。

FileMaker ESS 機能からPaylocity のデータに連携

  • FileMaker のデータベースの管理にて、「リレーションシップ」タブから「テーブル」を追加します。データソース として「ODBC データソース の追加」を選びます。
  • Filemaker 側の設定。
  • ODBC データソースを選択の画面で、MySQL ODBC Driver で設定したデータソース名(ドライバがMySQL ODBC 8.0 Unicode Driver のもの)を選択します。注意点としては、ここでCData ODBC ドライバのデータソース 名(CData Paylocity Sys)を選択しないでください。
  • Filemaker 側の設定。
  • 「データソース の編集」画面で以下の項目をセットして「OK」ボタンをクリックします。
    • 名前:任意(本例では「CData」)
    • 認証(ユーザ名とパスワードを指定) :SQL Gateway で設定した仮想MySQLへのログイン ユーザ名、および、パスワード
    • カタログ名:CData ODBC ドライバのDSN 名(CData Paylocity Sys)
  • Filemaker 側の設定。
  • 「テーブルを指定」ダイアログにてFileMaker のレイアウトで利用したデータソース 内のテーブルを選択します。
  • Filemaker 側の設定。
  • 「データベースの管理」に選択したテーブルが追加されたことを確認します。
  • Filemaker 側の設定。。
  • 指定したテーブルをレイアウトにセットします。データソース 内のデータが表示されれば成功です。
  • Filemaker 側の設定。

おわりに

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

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

関連コンテンツ

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

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