Cloud SQL へのPaylocity のデータのETL / ELT パイプラインを作ってデータを統合する方法

こんにちは！プロダクトスペシャリストの宮本です。

Cloud SQL はGoogle Cloud が提供するフルマネージドのRDB サービスです。CData Sync なら、Cloud SQL インスタンスにリアルタイムPaylocity のデータを反復同期できます。企業のあらゆるデータを一か所に統合して管理することが可能になり、アーカイブ、レポーティング、アナリティクス、機械学習、AI などでデータを活用できます。

1.データソースとしてPaylocity の接続を設定

まずはじめに、CData Sync のブラウザ管理コンソールにログインします。CData Sync のインストールをまだ行っていない方は本記事の製品リンクからCData Sync をクリックして、30日の無償トライアルとしてCData Sync をインストールしてください。インストール後にCData Sync が起動して、ブラウザ設定画面が開きます。

それでは、データソース側にPaylocity を設定していきましょう。左の［接続］タブをクリックします。

1. ［＋接続の追加］ボタンをクリックします。
2. ［データソース］タブを選択して、リスト表示されるデータソースを選ぶか、検索バーにデータソース名を入力して、Paylocity を見つけます。
3. Paylocity の右側の［→］をクリックして、Paylocity アカウントへの接続画面を開きます。もし、Paylocity のコネクタがデフォルトでCData Sync にインストールされていない場合には、ダウンロードアイコン（コネクタのアップロードアイコン）をクリックし、［ダウンロード］をクリックすると、CData Sync にコネクタがインストールされます。
4. 接続プロパティに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 を設定することを意味します。

5. ［作成およびテスト］をクリックして、正しくPaylocity に接続できているかをテストして保存します。これでレプリケーションのデータソースとしてPaylocity への接続が設定されました。

Cloud SQL をレプリケーションの同期先に設定

それでは、CData Sync を使ってCloud SQL にPaylocity のデータをレプリケーションするための設定を行っていきましょう。レプリケーションの同期先を追加するには、［接続］タブを開きます。次に、使用するCloud SQL サービス（MySQL、PostgreSQL、またはSQL Server）に応じて、適切な保存先を選択します。

MySQL

1. ［接続を追加］をクリックします。
2. MySQL を同期先として選択します。
3. 必要な接続プロパティを入力します。MySQL に接続するには、以下を設定します。
   • Server：接続するサーバーのIP アドレス、もしくはドメイン名。
   • Port：サーバーが稼働するポート。
   • User：データベースへの読み取り / 書き込みのアクセス権を持つユーザーのユーザー名。
   • Password：データベースへの読み取り / 書き込みのアクセス権を持つユーザーのパスワード。
   • Database：データベース名。
4. ［作成およびテスト］をクリックして、正しく接続できているかをテストします。
5. ［変更を保存］をクリックします。

PostgreSQL

1. ［接続を追加］をクリックします。
2. PostgreSQL を同期先として選択します。
3. 必要な接続プロパティを入力します。PostgreSQL に接続するには、次の接続プロパティを設定します。
   • Server：PostgreSQL データベースをホストしているサーバーのアドレス。
   • Port：PostgreSQL データベースをホスティングしているサーバーに接続する際のポート。
   • User：PostgreSQL データベースへの認証のためのユーザーID。
   • Password：PostgreSQL データベースへの認証のためのパスワード。
   • Database：データベース名。
4. ［作成およびテスト］をクリックして、正しく接続できているかをテストします。
5. ［変更を保存］をクリックします。

SQL Server

1. ［接続を追加］をクリックします。
2. SQL Server を同期先として選択します。
3. 必要な接続プロパティを入力します。SQL Server に接続するには、以下を設定します。
   • Server：SQL Server を起動しているコンピューターのネットワークアドレス名。
   • User：forms 認証を使う場合に、SQL Server との認証に使われるユーザー名。
   • Password：forms 認証を使う場合に、SQL Server との認証に使われるパスワード。
   • Database：SQL Server データベース名。

   Java 版

   Java 版では、Microsoft SQL Server JDBC Driver が必要です。Microsoft ダウンロードセンターからダウンロードできます。JDBC ドライバーをJava Web サーバーのlib フォルダにコピーして接続します。

4. ［作成およびテスト］をクリックして、正しく接続できているかをテストします。
5. これで同期先としてCloud SQL を設定できました。CData Sync では、Cloud SQL のデータベース名を指定するだけで、同期するPaylocity に併せたテーブルスキーマを自動的にCREATE TABLE してくれます。同期データに合わせたテーブルを事前に作成するなどの面倒な手順は必要ありません。もちろん、既存テーブルにマッピングを行いデータ同期を行うことも可能です。

3.Paylocity からCloud SQL へのレプリケーションジョブの作成

CData Sync では、レプリケーションをジョブ単位で設定します。ジョブは、Paylocity からCloud SQL という単位で設定し、複数のテーブルを含むことができます。レプリケーションジョブ設定には、［ジョブ］タブに進み、［＋ジョブを追加］ボタンをクリックします。

［ジョブを追加］画面が開き、以下を入力します：

1. 名前：ジョブの名前
2. データソース：ドロップダウンリストから先に設定したPaylocity を選択
3. 同期先：先に設定したCloud SQL を選択

すべてのオブジェクトをレプリケーションする場合

Paylocity のすべてのオブジェクト / テーブルをレプリケーションするには、［種類］セクションで［すべて同期］を選択して、［タスクを追加］ボタンで確定します。

作成したジョブ画面で、右上の［▷実行］ボタンをクリックするだけで、全Paylocity テーブルのCloud SQL への同期を行うことができます。

オブジェクトを選択してレプリケーションする場合

Paylocity から特定のオブジェクト / テーブルを選択してレプリケーションを行うことが可能です。［種類］セクションでは、［標準（個別設定）］を選んでください。

次に［ジョブ］画面で、［タスク］タブをクリックし、［タスクを追加］ボタンをクリックします。

するとCData Sync で利用可能なオブジェクト / テーブルのリストが表示されるので、レプリケーションを行うオブジェクトにチェックを付けます（複数選択可）。［タスクを追加］ボタンで確定します。

作成したジョブ画面で、［▷実行］ボタンをクリックして（もしくは各タスク毎の実行ボタンを押して）、レプリケーションジョブを実行します。

このようにとても簡単にPaylocity からCloud SQL への同期を行うことができました。

CData Sync の主要な機能を試してみる：スケジューリング・差分更新・ETL

ジョブのスケジュール起動設定

CData Sync では、同期ジョブを1日に1回や15分に1回などのスケジュール起動をすることができます。ジョブ画面の［概要］タブから［スケジュール］パネルを選び、［⚙設定］ボタンをクリックします。［間隔］と同期時間の［毎時何分］を設定し、［保存］を押して設定を完了します。これでCData Sync が同期ジョブをスケジュール実行してくれます。ユーザーはダッシュボードで同期ジョブの状態をチェックするだけです。

差分更新

CData Sync では、主要なデータソースでは、差分更新が可能です。差分更新では、最後のジョブ実行時からデータソース側でデータの追加・変更があったデータだけを同期するので、レプリケーションのクエリ・通信のコストを圧倒的に抑えることが可能です。

差分更新を有効化するには、ジョブの［概要］タブから「差分更新」パネルを選び、［⚙設定］ボタンをクリックします。［開始日］と［レプリケーション間隔］を設定して、［保存］します。

SQL での取得データのカスタマイズ

CData Sync は、デフォルトではPaylocity のオブジェクト / テーブルをそのままCloud SQL に複製しますが、ここにSQL、またはdbt 連携でのETL 処理を組み込むことができます。テーブルカラムが多すぎる場合や、データ管理の観点から一部のカラムだけをレプリケーションしたり、さらにデータの絞り込み（フィルタリング）をしたデータだけをレプリケーションすることが可能です。

ジョブの［概要］タブ、［タスク］タブへと進みます。選択されたタスク（テーブル）の［▶］の左側のメニューをクリックし、［編集］を選びます。タスクの編集画面が開きます。

UI からカラムを選択する場合には、［カラム］タブから［マッピング編集］をクリックします。レプリケーションで使用しないカラムからチェックを外します。

SQL を記述して、フィルタリングなどのカスタマイズを行うには、［クエリ］タブをクリックし、REPLICATE ［テーブル名］の後に標準SQL でフィルタリングを行います。

Paylocity からCloud SQL へのデータ同期には、ぜひCData Sync をご利用ください

このようにノーコードで簡単にPaylocity のデータをCloud SQL にレプリケーションできます。データ分析、AI やノーコードツールからのデータ利用などさまざまな用途でCData Sync をご利用いただけます。30日の無償トライアルで、シンプルでパワフルなデータパイプラインを体感してください。

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

CData Sync の 導入事例を併せてご覧ください。