Crystal Reports にPaylocity を連携してPaylocity のデータを使った帳票を作成

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Crystal Reports には、ODBC 標準向けのサポートが組み込まれています。CData ODBC Driver for Paylocity は、Crystal Reports でレポート作成ウィザードやその他のツールを使ってPaylocity へのアクセスを可能にします。この記事では、Paylocity の機能を持つシンプルな帳票を作成する方法を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Paylocity をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにPaylocity のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてPaylocity の接続を設定、2.Crystal Reports 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとPaylocity への接続設定

まずは、本記事右側のサイドバーからPaylocity ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

下記の手順に従って、レポート作成ウィザードを使ってPaylocity 接続を作成します。

1. ODBC 接続プロパティの指定がまだの場合は、DSN （データソース名）の設定を行います。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。一般的な接続プロパティは以下のとおりです：
   • OAuthClientID
   • OAuthClientSecret
   • RSAPublicKey
   • Key
   • IV

   Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

   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 を設定することを意味します。

2. 新しい帳票で、［Create New Connection］>［ODBC］をクリックします。

3. ウィザードが表示されたら［Select Data Source］をクリックし、［Data Source Name］メニューでDSN を選択します。

Paylocity のデータに連携する帳票をデザイン

ODBC 接続をPaylocity に追加したら、レポート作成ウィザードを使ってPaylocity を帳票に追加できます。

1. 帳票に必要なテーブルやフィールドを選択して、データソースを設定します。この例では、Employee テーブルのFirstName およびLastName カラムを使います。

2. チャートの種類を設定。 例えば、LastName をFirstName で表すシンプルなチャートを作成します。 ウィザードを完了すると、Crystal Reports はPaylocity に実行されるSQL クエリをビルドします。ドライバーは、リアル隊うPaylocity に対してクエリを実行します。

3. 必要に応じて、ほかのフィルタやレポートテンプレートを設定します。

4. データのインポートが終わったら、レポートフィールドをサマライズもしくはソートするチャートやレポートオブジェクトを作成できます。［Insert］>［Chart］をクリックして、チャートエキスパートを開きます。Total LastName by FirstName を表すグラフを作成するには、FirstName を［On Change Of］メニューセレクションの下のボックスに追加してからLastName を［Show Values］の下のボックスに追加します。

完成した帳票をプレビューして、チャートにデータが入っていることを確認します。Null 値を取り除きたい場合は、SelectionFormula を使います。

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

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