リアルタイムPaylocity のデータをPowerBI.com にパブリッシュ（発行）

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

CData Power BI Connector for Paylocity は、Power BI のツールおよびウイザードにシームレスに統合します。PowerBI.com へのリアルタイムデータのパブリッシュも可能です。次のステップで、Power BI Gateway を使って、自動リフレッシュ設定で、データをPower BI に公開します。

Power BI データソースとしてPaylocity を設定

CData Power BI Connector をインストールすると完了後にDSN 設定画面が開きます。ここでPaylocity への接続を設定します。

接続作業はWindows のODBC データソースアドミニストレータでも設定可能です。CData PowerBI REST DSN を選択します。 Power BI のbit 数（32 bit or 64 bit）に合わせたアドミニストレータを使うように気を付けてください。DSN 設定画面で必要な項目を入力してPaylocity のデータに接続します。入力後に接続のテストを行い、OK を押して接続を確立します。

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

Paylocity テーブルをPower BI からクエリ

次の手順でPaylocity からデータをPower BI からクエリできるようにします:

1. Power BI Desktop を開き、［データ］->［データを取得］->［その他］-> CData Paylocity を選択して接続を押します。次にサードパーティドライバーのプロンプトが出る場合には、そのまま続行します。
2. CData PowerBI Paylocity を［Data Source Name］欄に入力します。データ接続モードを選択します：
   インポート データをプロジェクトにインポートする。オンデマンドで更新が可能。
   DirectQuery リモートデータに直接アクセスする場合。
3. ナビゲーターダイアログで使用するテーブルを選択します。

4. ［データの変換］では、データをカスタマイズすることができます。クエリエディタを開いて、フィルタ、ソート、集計を設定できます。

   • カラムのデータ型の変更
   • カラムの削除
   • カラムのグルーピング

   Power BI は、コネクタが取得・検出したPaylocity のカラム毎のデータ型をそのまま使えます。

   Power BI は、データ変換を取得して、指定した条件でクエリを発行し、Paylocity からデータを取得します。

   ［読み込み］をクリックすると、そのままのデータがコネクタ経由でPower BI にロードされます。

データビジュアライゼーションを作成

データをPower BI から取得したら、レポートビューで取得したPaylocity フィールドをドラッグ＆ドロップしてビジュアライゼーションを作成します。チャートの種類を可視化ペインから選択し、フィールドのカラムをドラッグして設定します。

チャートの右上をクリックしてソートオプションを変更することもできます。

チャートの部分のハイライトも可能です。

取得したデータのビジュアライズ上でのフィルタリングをフィルタリングペインで行うことができます。

［更新］をクリックするとその時点でのリアルタイムデータをPaylocity から取得してレポートに反映させることができます。

オンプレミスデータゲートウェイでのPowerBI.com へのデータリフレッシュの設定

次の手順でPower BI オンプレミスゲートウェイ を使って、ローカルに設定したDSN のPaylocity のデータをPower BI のクラウド上から定期的にリフレッシュすることが可能です。

ゲートウェイモードの選択

まずはゲートウェイのモードを選択します。

• Gateway (個人用モード): Power BI にのみパブリッシュしてリフレッシュする場合はこちらを選択。ゲートウェイはWindows ユーザーアカウントで起動します。
• Gateway (formerly Enterprise): ほかのAzure サービスでゲートウェイが必要な場合には、こちらを選択します。また、複数のユーザーがゲートウェイにアクセスする場合にもデフォルトゲートウェイが必要です。
  デフォルトゲートウェイでアクセスする場合にはシステムDSN で接続する必要があります。ユーザーDSN だと特定のアカウントのみがアクセスでき、システムDSN のようにシステム全体からアクセスすることができないためです。CData Power BI Paylocity system DSN は、コネクタのインストールの最後のステップで設定します。

個人用モードゲートウェイの設定

Personal モードでのゲートウェイでのパブリッシュは、カスタムコネクタにアクセスできるゲートウェイをインストールする必要があります。

1. CData Power BI Connector インストーラーを実行します。ダウンロードはこちらから 可能です。
2. on-premises data gateway (personal mode) オプションを選択します。
3. ゲートウェイにサインインします。
4. ゲートウェイ名を設定し、Recovery Key を指定します。
5. コネクタセクションで、カスタムデータコネクタオプションを有効化します。.pqx ファイルが置かれたパスをオルタナティブパスとして設定することもできます。
   Note: CData Power BI Connectors は、デフォルトフォルダ（Your User Home\Documents\Power BI Desktop\Custom Connectors）に.pqx ファイルをインストールします。

ゲートウェイの設定

ゲートウェイ経由のパブリッシュには、コネクタへのアクセスが可能なゲートウェイのインストールとPowerBI.com からのPaylocity DSN への接続が必要です。

1. ゲートウェイのセットアップ

次の手順でマシン上にゲートウェイを設定します：

1. CData Power BI Connector インストーラーを起動します。Power BI Gateway のダウンロード も必要です。
2. on-premises data gateway (recommended) オプションを選択します。
3. ゲートウェイにサインインします。
4. ゲートウェイ名を設定し、Recovery Key を指定します。

5. ゲートウェイがCData Power BI Connector を見に行くフォルダを指定します。この記事では C:\Users\PBIEgwService\Documents\Power BI Desktop\Custom Connectors\ を使います。CData Connector の.pqx ファイル(C:\Users\USERNAME\Documents\Power BI Desktop\Custom Connectors\) を指定したフォルダに移します。

   NOTE: 指定されたサービスアカウント(NT SERVICE\PBIEgwService) は、ゲートウェイのアクセスフォルダに指定される必要があります。必要な場合には、ゲートウェイインストーラーのサービス設定で変更ができます。

6. コネクタセクションで、CData.PowerBI.Paylocity が表示されていることを確認します。

2. PowerBI.com からPaylocity のデータに接続する

1. ゲートウェイにデータソースを追加: PowerBI.com にログインして、設定メニューから［ゲートウェイの管理］を選択して、ゲートウェイクラスターの設定を実行。
2. ［このゲートウェイクラスターでユーザーのクラウドデータソースを更新することを許可する］オプションをクリック。
3. 適用を押して設定を保存します。
4. 続いてCData Power BI Connectorをデータソースとして追加します。
5. データソース設定セクションで、データソース名を入力し、データソースの種類にはCData Power BI Connector for Paylocity をドロップダウンから選択します。
6. Data Source Name には、システムDSN 名を入力します：CData Power BI Paylocity。
7. 設定後［すべての接続をテスト］ボタンをクリックし、［接続成功］が表示されれば、設定完了です。

PowerBI.com へのパブリッシュ

これでPaylocity のデータソースに連携してデータを更新できるレポートが発行できます。次の手順でデータセットを含むレポートをパブリッシュします。

1. Power BI Desktop で、［発行］ボタンを押して、レポートをPower BI へパブリッシュします。
2. PowerBI.com で、発行したワークスペースを選択します。
3. ［データセット］セクションで、設定したPaylocity のデータセットのオプションメニューをクリックして、［設定］をクリックします。
4. ［ゲートウェイ接続］セクションで、［データゲートウェイを使用する］を有効にします。状態がグリーンであることを確認し、適用を押して保存します。
5. 個人用モードでのゲートウェイ理世うでは、［データソースクレデンシャル］をクリックして、サインインします。

データセットの更新（リフレッシュ）

これでPower BI サイドからレポートのデータをPaylocity の最新のデータに更新できるようになりました。

• データの手動更新には、［ワークスペース］-> データセット］に進み、更新ボタンをクリックします。
• スケジュール更新には、［ワークスペース］->［データセット］に進み、更新のスケジュールをクリックします。データの更新オプションを有効にして、更新頻度を設定します。
• レポートビューでは、更新を押してレポートを最新のデータに同期できます。