CData JDBC Driver for Paylocity で Ignition SCADA と連携

Ignition は、Inductive Automation 社が提供する産業用の SCADA（監視制御およびデータ収集）および IIoT（産業用モノのインターネット）プラットフォームです。中核となる Gateway サービスが、デバイス接続やタグ、データベース接続を一元的に管理します。ただし、Ignition には Paylocity 用のコネクタが標準で用意されていません。そのため、Paylocity のデータを扱うには、独自のミドルウェアを用意するか、手作業でデータをエクスポートするのが一般的です。

CData JDBC Driver for Paylocity を使えば、この課題を解消できます。このドライバーは、Paylocity を標準的な JDBC（Java Database Connectivity）データソースとして利用できるようにするものです。Ignition はどの JDBC ドライバーも標準のデータベース接続として扱えるため、Gateway にドライバーを登録するだけで、Script Console や SQL Bridge、タグ、Perspective / Vision の画面からリアルタイムの Paylocity データをクエリできます。レプリケーションや独自コネクタ、ETL（抽出・変換・ロード）パイプラインは必要ありません。

この記事では、Ignition のインストールとコミッショニングから、CData JDBC Driver for Paylocity の登録、接続の作成、リアルタイムクエリによる動作確認までの流れを順を追って紹介します。

前提条件

• Windows 版 Ignition（Windows 10/11 または Windows Server）と、Windows サービスをインストールするための管理者権限
• CData JDBC Driver for Paylocity
• 有効な認証情報を持ち、API アクセスが有効化された Paylocity アカウント
• Gateway の Web インターフェースを開くための対応デスクトップブラウザ（Google Chrome、Mozilla Firefox、Microsoft Edge、Safari のいずれか）

ステップ 1：Ignition のインストールとセットアップ

Ignition をすでにインストールして稼働させている場合は、ステップ 2 に進んでください。

Ignition のダウンロード

1. Inductive Automation のダウンロードページにアクセスし、Windows 版の Ignition をダウンロードします。
2. このファイルひとつで Ignition Gateway のフルインストーラーになっています。Gateway サービスと Designer Launcher の両方が含まれているので、Designer を別途ダウンロードする必要はありません。

Ignition のインストール

1. インストーラーを実行し、ライセンス契約に同意してインストール先を選択します。
2. Windows の起動時に Gateway も自動で起動するよう、Install as a Windows Service にはチェックを入れたままにしておきます。
3. インストールを完了すると Gateway サービスが起動し、ブラウザで http://localhost:8088 が開いてコミッショニングウィザードが表示されます。Browser Not Supported と表示された場合は、Chrome、Firefox、Edge、Safari のいずれかで同じアドレスを開いてください。

Gateway のコミッショニング

1. Commission Ignition Gateway ウィザードで Gateway Name を設定し、管理者のユーザー名とパスワードを作成します。
2. エンドユーザー使用許諾契約に同意し、トライアルを開始するか、購入済みの Ignition ライセンスをアクティベートします。
3. コミッショニングが完了したら、管理者アカウントでログインします。Gateway の Home ページが表示されます。

注意: トライアル版では Gateway の各ページにカウントダウンタイマーが表示され、Gateway サービスを再起動するとタイマーがリセットされます。テスト用途であれば問題ありませんが、本番環境で利用する場合はライセンスが必要です。

ステップ 2：Ignition への CData JDBC Driver の登録

Ignition では、サードパーティ製の JDBC ドライバーを Gateway の Web インターフェースからアップロードできます。ファイルシステムを直接操作する必要はありません。

1. 管理者として Gateway にログインします。
2. Connections > Databases > Settings に移動して Drivers タブを開き、Create JDBC Driver をクリックします。
3. ダイアログで次の内容を入力します。
   • Name: Paylocity
   • Classname: cdata.jdbc.paylocity.PaylocityDriver
   • Driver Type: Generic
   • Default Validation Query: SELECT FirstName FROM Employee LIMIT 1
   
4. Create JDBC Driver をクリックします。現行の Ignition 8.3 では作成ダイアログに JAR（Java アーカイブ）ファイルのアップロード欄がないため、JAR ファイルは次の手順で追加します。
5. 作成したドライバーの行の右端にあるメニューを開いて Manage JAR files を選択し、ドライバーのインストールディレクトリ内の lib フォルダにある cdata.jdbc.paylocity.jar をアップロードして保存します。
6. ドライバー一覧で、ドライバーのステータスが INSTALLED になっていることを確認します。

ステップ 3：Paylocity への接続の作成

1. Connections > Databases > Connections に移動し、Create Database Connection をクリックします。
2. Driver Selection ステップで Paylocity を選択し、Next をクリックします。
3. Database Setup ステップで、Name に Paylocity を設定します。認証情報は接続 URL に含めるため、Username は空欄のままにし、Password は None を選択します。
4. Connect URL に接続文字列を入力します。

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

   
5. Create Database Connection をクリックし、Database Connections ページで接続のステータスが VALID になっていることを確認します。

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 を設定する必要があるという意味です。

注意: パスワードやトークンにセミコロンが含まれていると接続 URL が正しく解釈されません。その場合は、セミコロンを含まない値に再設定してください。

ステップ 4：Ignition からリアルタイムの Paylocity データをクエリ

接続が有効になったら、Designer からリアルタイムの Paylocity データをクエリしてみましょう。

1. Ignition Designer Launcher を開き、使用する Gateway を選択して Open Designer をクリックします（一覧に Gateway が表示されていない場合は、Add Designer をクリックして http://localhost:8088 を入力します）。Gateway の管理者アカウントでログインしてください。
2. プロジェクトを開くか、新規に作成します。Designer が開き、Project Browser、Tag Browser、Component Palette の各パネルが表示されます。
3. Designer で Tools > Script Console に移動します。Multiline Buffer にテストクエリを入力し、Execute をクリックします。Employee の部分は、Paylocity 接続で利用可能な任意のテーブルに置き換えてください。

   print system.db.runQuery(
       "SELECT FirstName, LastName FROM Employee LIMIT 10",
       "Paylocity")

   
4. クエリが成功すると、Interactive Interpreter パネルに PyDataset rows:10 cols:2 と出力されます。これで、Ignition が CData JDBC Driver を介して Paylocity からリアルタイムデータを取得できたことを確認できます。

注意: スクリプト内の接続名は、ステップ 3 で設定した接続名と一致させる必要があります。

ステップ 5：結果の検証

1. 取得した行を出力し、Paylocity 上の同じレコードと値を照合します。

   ds = system.db.runQuery("SELECT FirstName, LastName FROM Employee LIMIT 10", "Paylocity")
   for row in ds:
       print row["FirstName"], row["LastName"]

2. 必要に応じて、別のテーブルへのクエリやフィルタ付きのクエリも実行し、スキーマの検出とフィルタリングが正しく機能することを確認します。
3. 必要に応じて Gateway サービスを再起動し、接続のステータスが VALID に戻ることを確認します。

トラブルシューティング

Ignition 以外の環境でのドライバーのテスト

Gateway とは切り離してドライバー単体の動作を確認したい場合は、次のスタンドアロンの Java サンプルを実行してみてください。cdata.jdbc.paylocity.jar と cdata.jdbc.paylocity.lic は同じディレクトリに配置し、クラスパスに含めておく必要があります。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class CDataExample {
    public static void main(String[] args) throws Exception {
        Class.forName("cdata.jdbc.paylocity.PaylocityDriver");
        String connectionString = "jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;";
        try (Connection conn = DriverManager.getConnection(connectionString)) {
            Statement stmt = conn.createStatement();
            ResultSet rs = stmt.executeQuery("SELECT FirstName, LastName FROM Employee LIMIT 10");
            while (rs.next()) {
                System.out.println(rs.getString("FirstName") + ", " + rs.getString("LastName"));
            }
        }
    }
}

---

CData で Ignition にリアルタイムかつガバナンスの効いた Paylocity 連携を

CData JDBC Driver for Paylocity を登録すれば、ETL 基盤や手作業でのエクスポート、独自の連携コードを用意することなく、Ignition からリアルタイムの Paylocity データをクエリできます。同じ接続をタグや SQL Bridge、Perspective / Vision の画面でも再利用できます。

無料トライアルで、CData を使って Ignition から数百もの外部システムへリアルタイムかつセキュアにアクセスできることを、ぜひお確かめください。