Cognos BI でPaylocity データを使ってデータビジュアライゼーションを作成

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

CData ODBC Driver for Paylocity を使って、Paylocity データをドラッグアンドドロップ スタイルのCognos Report Studio に連携できます。この記事では、データビジュアライゼーションをSQL を書かずに作成するグラフィカルアプローチと、Paylocity がサポートする任意のSQL クエリを実行する方法の両方について説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

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

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

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

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

下記の手順に従って、［Cognos Administration］ツールのライブ Paylocity に接続を確立します。この接続はCognos BI 全体で使えます。このドライバーを使って、すべてのユーザーは一貫したデータおよびメタデータ：リアルタイムPaylocity を利用できます。

1. 接続プロパティの指定がまだの場合は、ODBC DSN （データソース名）で行います。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。

   64ビット版のマシンからCognos を実行している場合は、32ビット版ODBC データソースアドミニストレーターを起動する必要があります。以下のコマンドで開くことができます：

   C:\Windows\sysWOW64\odbcad32.exe

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

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

2. ［Cognos Administration］を開いて新しいデータソースを追加します。［Data Source Connections］をクリックして［ODBC］オプションを選択したら、システムDSN とユーザーフレンドリーな名前を入力します。Click Retrieve Objects and choose the CData Paylocity database object.

Data Visualizations をレポートに追加

これで、［Source Explorer］からレポートオブジェクトにカラムをドラッグアンドドロップしてCognos Report Studio のPaylocity データ にレポートを作成できます。以下では、最新データを表示するチャートを持つシンプルなレポートを作成する方法を説明します。

レポートをビルドすると、Cognos Report Studio はSQL クエリを生成して実行をドライバーに依存します。ドライバーはクエリをPaylocity API へのリクエストに変換します。ドライバーはリアルタイムPaylocity へのクエリの実行を基になるAPI に依存します。

アグリゲートに基づきチャートを作成

［Source Explorer］からオブジェクトのdimentions にカラムをドラッグアンドドロップするだけで、Cognos レポートオブジェクトとしてPaylocity データを使うことができます。チャートのSeries dimension のカラムは自動的にグループ化されます。

さらにCognos は、measure dimesion のロジカルなデフォルトアグリゲート関数をデータタイプに基づいて設定します。この例では、デフォルトをオーバーライドしています。［Data Items］タブの LastName カラムをクリックしてAggregate Function プロパティを Not Applicableに設定します。Rollup Aggregate Function プロパティは Automatic に設定する必要があります。

Query オブジェクトをSQL に変換

必要なクエリを把握している、あるいは生成されたクエリを調整したい場合は、query オブジェクトをSQL ステートメントに変換します。クエリがSQL に変換されると、UI コントロールはquery オブジェクトで利用できなくなります。下記の手順に従って、ユーザー定義のSQL でチャートを埋めます。

Cognos はユーザー定義クエリの実行をドライバーに依存します。ドライバーのSQL エンジンを使うと、キャッシュデータのコピーがないためクエリは常に最新の結果を返します。

1. ［Query Explorer］の上にカーソルを置き、［Queries］フォルダをクリックしてレポートにquery オブジェクトを表示します。

2. 自動生成されたクエリを編集したい場合は、Generated SQL プロパティにあるquery オブジェクトのボタンをクリックします。ダイアログが表示されたら、［Convert］をクリックします。

   新たにSQL ステートメントを入力したい場合は、query オブジェクトと一緒にSQL オブジェクトをドロップします。

3. SQL オブジェクトのプロパティを編集：SQL プロパティでPaylocity データソースを選択してSQL Syntax プロパティをNative に設定します。

4. SQL プロパティのボタンをクリックし、ダイアログが表示されたらSQL クエリを入力します。この例では以下のクエリを使います：

   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'

5. query オブジェクトのプロパティを編集：Processing プロパティを［Limited Local］に設定します。この値はquery オブジェクトをSQL に変換するために必要です。

クエリ結果をチャートで使用

これで［Data Items］タブのオブジェクトとしてSQL クエリ結果にアクセスできるようになりました。下記の手順に従って、クエリ結果を使ってチャートを作成します；例えば、Employee テーブルからLastName を各FirstName へ。

1. ［Page Explorer］ 上にカーソルを置きpage オブジェクトをクリックしてページに戻ります。
2. 円グラフをツールボックスからワークスペース上にドラッグします。
3. チャートのプロパティで、Query プロパティに先ほど作成したクエリの名前を設定します。
4. ［Data Items］タブをクリックしてカラムをx およびy 軸上にドラッグします。この例ではFirstName カラムをSeries (pie slices) ボックスに、LastName カラムをDefault Measure ボックスにドラッグします。

5. Default Measure (LastName 値) のデフォルトのプロパティを編集します：［Aggregate Function］ボックスで "Not Applicable" オプションを選択します。

レポートを実行してクエリ結果を追加します。