Power BI データフローでPaylocity データを分析用にデータプレパレーション

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

Power BI データフロー は、Power BIが持つデータ準備（Data Preparation）の機能です。この機能を使用することで、様々なデータソースに接続してデータをクレンジング・変換してPower BIストレージに読み込むことが出来ます。Power BI データフローでCData Power BI Connector for Paylocity を使うことで、Paylocity データをノーコードで連携して、データ加工・データ準備で使用することができます。本手順では、CData Power BI Connectors 製品で、PowerBIゲートウェイ経由でPaylocity に連携する方法を紹介します。

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

接続テストを押して接続を確認します。成功したらOK を押して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 が表示されていることを確認します。

Power BI データフロー からPaylocity データの利用

• Power BI サービスのゲートウェイの管理を開き、ゲートウェイクラスタにOnーPremises data gateway で作成したゲートウェイが追加されていることを確認します。「すべての接続をテスト」をクリックして「オンライン：準備が整いました。」が表示されていることを確認します。
• ワークスペースを開き、「＋作成 > データフロー 」を開きます。
• 「データフロー の作成を開始する」にて「新しいエンティティの定義」を選択します。
• データソース 一覧内の「ODBC」を選択します。
• ODBC の接続設定にて以下の通りセットして「次に」進みます。
  • ODBC接続文字列：　DSN = CData Power BI {データソース名} 　　※Power BI コネクタでカスタムコネクタとして登録しているデータソース のDSN 名をセットください
  • オンプレミスデータゲートウェイ：既に作成したゲートウェイを選択します
  • 認証の種類：匿名（データソース毎の認証設定は、ODBC のDSN 設定にて行います）
• 「PowerQuery - データの選択」画面に切り替わります。左側のエクスプローラで「ODBC > CData > {データソース名}」フォルダを開くとCData Power BI Connectors で接続しているデータソース のテーブルリストが表示されます。データを変換する対象テーブルを選択すると右側にプレビューが表示されます。「データの変換」ボタンをクリックして次に進みます。
• 「PowerQuery - クエリを編集」画面に切り替わるので必要に応じてデータ加工を行い「保存して閉じる」をクリックします。
• データフロー に任意の名称を付与して「保存」します。
• 作成したデータフロー は、ワークスペースの「データフロー」タブから確認できます。
• 作成したデータフロー に自動でデータを最新化するスケジュールを設定してみます。アクション列内の「更新のスケジュール設定」ボタンをクリックします。「設定」の「データフロー」タブが開きます。「スケジュールされている更新」を開き、「データを最新に保つ」をONにします。更新の頻度（本画面の例では、毎日朝6時）を設定して「適用」します。本設定で、毎朝6時に本データフロー内のデータが最新化される処理が自動で行われるようになります。

まとめ

Power BI データフローでデータ加工済みのデータを保存しておくことで、チームで本データフローのデータを利用したレポートを作成して共有するようなことが可能となります。CData Power BI Connectors 製品は製品ページ からダウンロードしてご利用いただけます。