ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →CData
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData ODBC Driver for Paylocity は、PHP アプリケーションからPaylocity データへの連携を実現します。本記事では、Paylocity データをPHP のビルトインODBC 機能でクエリする手順を説明します。
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
Paylocity に接続するDSN を作成します。
Paylocity への接続を確立するには以下を設定します。
このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。
Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。
OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。
Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。
UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。
odbc_connect を呼び出して、Paylocity への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。
$conn = odbc_connect("CData Paylocity Source","user","password");
コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:
$conn = odbc_pconnect("CData Paylocity Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。
$query = odbc_prepare($conn, "SELECT * FROM Employee WHERE EmployeeId = ?");
Prepared ステートメントをodbc_execute を使って実行します。
$conn = odbc_connect("CData Paylocity Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Employee WHERE EmployeeId = ?");
$success = odbc_execute($query, array('1234'));
Non-Parameterized クエリは、odbc_exec を使います。
$conn = odbc_connect("CData Paylocity Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Employee");
odbc_fetch_array ファンクションの結果セット配列としてアクセスします。
$conn = odbc_connect("CData Paylocity Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Employee");
while($row = odbc_fetch_array($query)){
echo $row["FirstName"] . "\n";
}
odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。
$conn = odbc_connect("CData Paylocity Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Employee WHERE EmployeeId = ?");
$success = odbc_execute($query, array('1234'));
if($success)
odbc_result_all($query);
スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。
PHP の最新版のバイナリのダウンロード。
フォルダにファイルを入れる。
フォルダを開く。
php.ini-development をphp.ini に変更。
ブラウザからテストスクリプトにアクセスするためのコマンドを実行。
php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、Paylocity 向けに最適化したものです。
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。