PolyBase を使用して Paylocity のデータを外部データソースとして接続

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData Connect AI とPolyBase を使用して、リアルタイムのPaylocity のデータにアクセスできる外部データソースをSQL Server に作成できます。

SQL Server のPolyBase を使用すると、データベーステーブルのクエリに使用するのと同じTransact-SQL 構文を使用して外部データをクエリできます。CData ODBC Driver for Paylocity と組み合わせることで、SQL Server データのすぐ隣でPaylocity のデータに直接アクセスできます。この記事では、外部データソースと外部テーブルを作成して、T-SQL クエリを使用してリアルタイムのPaylocity のデータにアクセスできるようにする方法を説明します。

注意:PolyBase はSQL Server 19 以降でのみ使用できます。

CData Connect AI は Paylocity 専用のSQL Server インターフェースを提供し、ネイティブでサポートされているデータベースにデータをレプリケートすることなく Paylocity のデータをクエリできます。最適化されたデータ処理を標準で使用し、CData Connect AI はサポートされているすべてのSQL 操作(フィルター、JOIN など)を Paylocity に直接プッシュし、サーバーサイド処理を活用して必要なPaylocity のデータを迅速に返します。

PolyBase 用に Paylocity への接続を設定

PolyBase から Paylocity への接続は、CData Connect AI によって実現されます。PolyBase からPaylocity のデータを操作するには、まず Paylocity 接続を作成し設定します。

  1. Connect AI にログインして「Sources」をクリックし、 Add Connection をクリックします
  2. Add Connection パネルから「Paylocity」を選択します
  3. 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 を設定することを意味します。

  4. Save & Test をクリックします
  5. Add Paylocity Connection ページの「Permissions」タブに移動し、ユーザーベースの権限を更新します。

Personal Access Token の追加

REST API、OData API、またはVirtual SQL Server 経由でConnect AI に接続する場合、Personal Access Token(PAT)を使用してConnect AI への接続を認証します。アクセス管理の粒度を維持するために、サービスごとに個別のPAT を作成することをお勧めします。

  1. Connect AI アプリの右上にある歯車アイコン()をクリックして設定ページを開きます。
  2. Settings ページで「Access Tokens」セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて「Create」をクリックします。
  4. Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。

接続の設定とPAT の生成が完了したら、Polybase からPaylocity のデータに接続する準備が整いました。

Paylocity のデータ用の外部データソースを作成

接続を設定した後、外部データソース用の資格情報データベースを作成する必要があります。

資格情報データベースの作成

Paylocity のデータ に接続する外部データソースの資格情報を作成するには、以下のSQL コマンドを実行します。

注意IDENTITY にはConnect AI のユーザー名を、SECRET にはPersonal Access Token を設定します。


CREATE DATABASE SCOPED CREDENTIAL ConnectCloudCredentials
WITH IDENTITY = 'yourusername', SECRET = 'yourPAT';

Paylocity 用の外部データソースを作成

PolyBase で Paylocity 用の外部データソースを作成するには、CREATE EXTERNAL DATA SOURCE SQL コマンドを実行します:


CREATE EXTERNAL DATA SOURCE ConnectCloudInstance
WITH (
  LOCATION = 'sqlserver://tds.cdata.com:14333',
  PUSHDOWN = ON,
  CREDENTIAL = ConnectCloudCredentials
);

Paylocity 用の外部テーブルを作成

外部データソースを作成した後、CREATE EXTERNAL TABLE ステートメントを使用して、SQL Server インスタンスからPaylocity のデータにリンクします。テーブルのカラム定義は、CData Connect AI で公開されているものと一致する必要があります。Connect AI のData Explorer を使用してテーブル定義を確認できます。

サンプルCREATE TABLE ステートメント

外部テーブルを作成するには、CREATE EXTERNAL TABLE SQL コマンドを実行し、照合順序を使用してLOCATION に接続、カタログ、テーブルの3部構成の表記を設定します。Paylocity Employee に基づいて外部テーブルを作成するステートメントは、次のようになります。

CREATE EXTERNAL TABLE Employee(
  FirstName COLLATE [nvarchar](255) NULL,
  LastName COLLATE [nvarchar](255) NULL,
  ...
) WITH (
  LOCATION='Paylocity1.Paylocity.Employee',
  DATA_SOURCE=ConnectCloudInstance
);

SQL Server インスタンスに Paylocity 用の外部テーブルを作成したので、ローカルデータとリモートデータを同時にクエリできるようになりました。SQL Server データベースから300以上のSaaS、Big Data、NoSQL ソースへのリアルタイムデータアクセスを実現するために、CData Connect AI を今すぐお試しください!

はじめる準備はできましたか?

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル お問い合わせ