ODBC Driver for Paylocity

Build 24.0.9062

Linux DSN の構成

このセクションでは、以下のいくつかのLinux ディストリビューションでODBC 接続をセットアップしDSN を設定する方法を説明します：Ubuntu のようなDebian ベースのシステム、Red Hat Enterprise Linux (RHEL)、およびFedora のようなRed Hat Linux プラットフォーム。

Linux の最小バージョン

Red Hat ベースおよびDebian ベースシステムでサポートされる最小バージョンは以下のとおりです。

OSMin. Version
Ubuntu18.04
Debian10
RHEL8
Fedora28
SUSE15

ドライバー依存関係のインストール

必要な依存関係をインストールするには、次のコマンドをルートとしてまたはsudo で実行します。

  • Debian/Ubuntu: 
    apt-get install libc6 libstdc++6 zlib1g libgcc1
  • RHEL/Fedora: 
    yum install glibc libstdc++ zlib libgcc

ドライバーのインストール

標準のパッケージ管理システムを使用してドライバーをインストールできます。

Ubuntu のようなDebian ベースのシステムでは、次のコマンドをroot またはsudo で実行します。 

dpkg -i /path/to/driver/setup/PaylocityODBCDriverforUnix.deb

RPM パッケージ形式をサポートするシステムでは、次のコマンドをroot またはsudo で実行します。 

rpm -ivh /path/to/driver/PaylocityODBCDriverforUnix.rpm

ドライバーのライセンス

次のコマンドを実行して本製品 のライセンスを取得します。評価版をアクティベートするには、<key> の入力を省略してください。 

cd /opt/cdata/cdata-odbc-driver-for-paylocity/bin/
sudo ./install-license.sh <key>

ドライバーマネージャー経由の接続

ドライバーマネージャーはドライバーをロードし、アプリケーションからドライバーに関数呼び出しを渡します。本製品 をドライバーマネージャーに登録して、ドライバーマネージャーのコンフィギュレーションファイルにDSN を定義する必要があります。

本製品 のインストールでは、本製品 をunixODBC ドライバーマネージャーに登録し、システムDSN を作成します。UnixODBC ドライバーマネージャーは、Python やその他多くのアプリケーションから使用できます。アプリケーションに別のドライバーマネージャーが組み込まれている可能性があります。

DSN の作成

unixODBC をインストールしてDSN を設定するには、unixODBC の使用 を参照してください。OBIEE、Informatica、およびSAS に接続するDSN を作成するには、DataDirect ドライバーマネージャーの使用 を参照してください。

Paylocity への接続

Paylocity は、Pay Entry API 経由と標準のPaylocity API 経由の2つの接続方法を提供します。

接続する前に、次のプロパティを設定します（該当する場合）。

  • サンドボックスアカウントを使用する場合はUseSandbox をtrue に設定し、そうでない場合はfalse に設定します。
  • IncludeCustomFields がtrue の場合、CustomFieldsCategory をCustomfields カテゴリに設定します。 デフォルト値はPayrollAndHR です。

暗号化をオプトインしているサイトの場合：

  • 次の暗号化プロパティのいずれか1つだけを設定してください。
    • Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。この鍵はPaylocity コンテンツの暗号化に使用されます。Paylocity はRSA 復号化を使用してAES 鍵を復号化します。
      IV 値が指定されていない場合に使用されます。
    • IV：Paylocity を暗号化するときに使用するAES IV（base 64 エンコード）。Key 値が提供されない場合は、IV は内部的に生成されます。
  • Paylocity アカウントでRSA 暗号化が有効になっている場合は、RSAPublicKey をPaylocity に関連付けられたRSA キーに設定します。 （このプロパティは、Insert およびUpdate ステートメントを実行する場合は必須です。）この機能が無効になっている場合は必須ではありません。

Pay Entry API

Pay Entry API は、個々の従業員の給与情報を自動的に提出することを可能にする、極めて限定的な接続であり、それ以外のことはほとんどできません。Pay Entry API で提供されるものは極めて限定されているため、独立したスキーマはありません。しかし、UsePayEntryAPI 接続プロパティで有効にすることができます。

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。

UsePayEntryAPI をtrue に設定する場合は、以下のストアドプロシージャのみ利用できることに注意してください。

製品のその他の機能を使用しようとするとエラーが発生します。

また、Pay Entry API で使用するために取得したOAuthAccessToken は、別途保存する必要があります。このため、この接続プロパティを使用する際には、別のOAuthSettingsLocation の設定が必要になることがよくあります。

Paylocity への認証

Paylocity は、Pay Entry API または標準のPayloticity API からのデータへのすべての接続でOAuth 認証をサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの最も一般的な認証フローでのPaylocity への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Paylocity で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

デスクトップアプリケーション

カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ：

  • InitiateOAuth = GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
  • OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。
  • CallbackURL = アプリケーションの登録時に定義されたリダイレクトURI。

接続すると、本製品 はデフォルトブラウザでPaylocity のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する前に、次の接続プロパティを設定します。
    • InitiateOAuth = REFRESH。
    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation = 本製品 がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。
    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。 以下のいずれかの方法で行います。

  • オプション1：OAuthVerifier 値を取得します。
  • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。以下の手順に従います。

  1. インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

    次のプロパティを設定します。

    • InitiateOAuth = OFF。
    • OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。

  2. カスタムOAuth アプリケーションの登録時に定義したCallbackURL を取得します。（カスタムOAuth アプリケーションの作成 を参照してください。） 新しいブラウザのタブにこのURL を貼り付けます。

  3. ログインして、本製品 にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。

  4. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

    • InitiateOAuth = REFRESH。
    • OAuthVerifier = 控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
    • OAuthSettingsLocation = 暗号化されたOAuth 認証値を指定されたファイルに永続化。
    • OAuthClientId = カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret = カスタムOAuth アプリケーション設定のクライアントシークレット。

  5. 接続をテストしてOAuth 設定ファイルを生成します。

  6. 次のプロパティを再設定して、接続してください。

    • InitiateOAuth = REFRESH。
    • OAuthSettingsLocation = 暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。
    • OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでデータに接続するには、次の接続プロパティを設定します。

  • InitiateOAuth = REFRESH
  • OAuthSettingsLocation = ブラウザでマシンからコピーしたOAuth 設定ファイルへのパス。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。
  • OAuthClientId = カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret = カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

OAuth 値のリフレッシュ

本製品 は、ブラウザベースのOAuth 認証交換中に取得されたテンポラリーOAuth アクセストークンをリフレッシュできます。デフォルトでは、本製品 は暗号化されたトークンを、DSN に対応するodbc.ini ファイルに保存します。System DSN の場合、このodbc.ini ファイルへのアクセスを制限できます。

トークンの自動交換を有効にするには、本製品 にシステムodbc.ini への書き込みアクセス権を与えます。または、OAuthSettingsLocation 接続プロパティを、ドライバーが読み書きアクセス権を持つ別のファイルパスに設定することもできます。 

    OAuthSettingsLocation=/tmp/oauthsettings.txt

OAuth 認証の依存関係のインストール

OAuth 認証標準は、認証するユーザーにWeb ブラウザを使用したPaylocity との通信を要求します。最初のOAuth インタラクションがドライバーがインストールされている同じマシン上で行われる場合（例えばデスクトップアプリケーションの場合）、本製品 はデフォルトブラウザを立ち上げるxdg-open プログラムにアクセスする必要があります。

この依存関係を満たすには、パッケージマネージャーに対応するパッケージをインストールします。

Debian/Ubuntu PackageRHEL/Fedora PackageFile
xdg-utilsxdg-utilsxdg-open

ドライバーエンコーディングの設定

ODBC ドライバーは、ODBC ドライバーマネージャーで使用するエンコーディングを指定する必要があります。デフォルトでは、Unix 用のCData ODBC ドライバーはunixODBC と互換性のあるUTF-16 を使用するように設定されていますが、他のドライバーマネージャーでは代替エンコーディングが必要な場合があります。

また、ANSI ODBC API を使用するアプリケーションからODBC ドライバーを使用している場合は、ANSI コードページを設定する必要があります。例えば、ANSI アプリケーションに日本語の文字をインポートするには、設定ファイル'/opt/cdata/cdata-odbc-driver-for-paylocity/lib/cdata.odbc.paylocity.ini' でコードページを指定できます。 

[Driver]
AnsiCodePage = 932

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062