CData Power BI Connector for Paylocity はじめに:インストールから接続まで
このガイドでは、CData Power BI Connector for Paylocity の使い方を詳しく解説します。コネクタのインストールとライセンス認証、初回接続の設定、そしてアプリケーションで Paylocity のデータ を操作するための次のステップをご紹介します。
インストールとライセンス認証
CData Power BI Connector for Paylocity を使用すると、Power BI Desktop および Power BI オンプレミスデータゲートウェイからライブの Paylocity のデータ に直接接続できます。このセクションでは、インストールの前提条件、プラットフォームサポート、コネクタのデプロイ、およびライセンス要件について詳しく説明します。
システム要件
このコネクタは、Microsoft Power BI Desktop および Power BI Gateway が利用可能な環境でサポートされています。これらのコンポーネントは Windows 専用のため、Power BI Connector は Windows プラットフォームのみでサポートされています。
オペレーティングシステムのサポート
- Windows 10(64 ビット)
- Windows 11(64 ビット)
- Windows Server 2016、2019、または 2022(Power BI Gateway デプロイメントに推奨)
Power BI コンポーネント
- Power BI Desktop(最新バージョンを推奨):レポートのデザイン、データモデリング、およびコネクタの設定に使用します。
- Power BI オンプレミスデータゲートウェイ:スケジュール更新またはクラウドに公開されたデータセットに必要です。
ソフトウェアの依存関係
Microsoft Visual C++ 2015-2022 再頒布可能パッケージ(まだインストールされていない場合は自動的にインストールされます)。
Power BI Connector のインストール
Windows
- CData Power BI Connector for Paylocity をダウンロードします。
- インストーラーを実行し、インストールウィザードに従います。
- インストーラーがセットアッププロセスを案内し、コネクタをデフォルトのインストールディレクトリにデプロイします。
- インストール中にライセンスキーの入力を求められる場合があります。
- ライセンスキーは CData Orders チームからメールで届いているはずです。
- ライセンスキーは次のような形式です:XXXX-XXXX-XXXX-XXXX-XXXX
Note:試用版を実行する場合は、Trial Key オプションを選択してください。
- インストール後、以下の場所でコネクタファイルを確認します: C:\Program Files\CData\CData Power BI Connector for Paylocity\CData.Paylocity.pqx
- .pqx ファイルを Power BI Desktop のカスタムコネクタフォルダにコピーします(初回のみ): Documents\Power BI Desktop\Custom Connectors
- Power BI Desktop を再起動します。カスタム拡張機能を有効にするよう求められた場合:
- ファイル -> オプションと設定 -> オプション を選択します
- セキュリティを選択します
- データ拡張機能で「検証なしで任意の拡張機能の読み込みを許可する」を選択します
- Power BI Desktop を再起動します
- Power BI Gateway デプロイメントの場合は、同じ .pqx ファイルをゲートウェイのカスタムコネクタディレクトリにコピーし、ゲートウェイサービスを再起動して読み込みます。
ライセンスの認証
CData Orders チームからメールでライセンスキーを受け取っているはずです。 ライセンスキーは次のような形式です:XXXX-XXXX-XXXX-XXXX-XXXX
Windows でのライセンス認証
通常、ライセンスはインストール中に認証されます。ただし、手動での認証が必要な場合があります。以下の手順で Power BI Connector の手動認証を行います:
- スタートメニューから ODBC ドライバーアプリケーション(DSN)を開きます。
- ユーザー DSN または システム DSN を選択し、CData PBI Paylocity Source/Sys を開きます。
- About タブに移動します。
- License Information セクションの Activation フィールドにライセンスキーを入力し、Activate! をクリックします。
- 認証が成功すると、コネクタに「Licensed」ステータスが表示されます。OK をクリックします。
ライセンスに関するよくある質問
ライセンスは複数のマシンで使用できますか?
はい、サブスクリプションプランによります。注文確認メールを確認するか、アカウント担当者にお問い合わせください。アカウント担当者が不明な場合は、[email protected] までお問い合わせください。
ライセンスキーを紛失しました。どうすれば取得できますか?
注文番号を添えて [email protected] までメールでお問い合わせいただければ、ライセンスキーを再送いたします。
ライセンスを別のマシンに移行できますか?
はい。ライセンスを別のマシンに移行するには、以下のリンクからライセンス移行リクエストを送信する必要があります:
https://www.cdata.com/lic/transfer/
ライセンス移行リクエストが送信され、正常に処理されると、プロダクトキーにアクティベーションが追加され、別のマシンで正規ライセンスを認証できるようになります。このプロセスが完了すると、以前のマシンのライセンスは無効になります。
ライセンスに関するその他のご質問は、[email protected] までお問い合わせください。ライセンスの確認とアップグレードは、セルフサービスポータル portal.cdata.com から行えます。
接続設定
ドライバーがインストールされ、ライセンスが認証されたら、Paylocity への接続を設定できます。CData Power BI Connector for Paylocity は ODBC ドライバー上に構築されているため、DSN(データソース名)を使用して接続プロパティを保存します。
DSN の作成
Windows:ODBC データソース アドミニストレーターの使用
- ODBC データソース アドミニストレーター(64 ビット)を開きます
Note:CData Power BI Connector は 64 ビット版を使用します。
- Windows スタートメニューで「ODBC」と検索します
- または、コントロールパネル -> 管理ツール -> ODBC データソース に移動します
- システム DSN または ユーザー DSN タブをクリックします
- システム DSN:マシン上のすべてのユーザーが利用可能(サービス用に推奨)
- ユーザー DSN:現在のユーザーのみ利用可能
- リストから CData PBI Paylocity Source または Sys(ユーザー DSN またはシステム DSN に応じて)を選択するか、追加をクリックして新しいデータソースを作成します。
- 完了をクリックして接続設定ダイアログを開きます。
接続プロパティの設定
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 をクリックして DSN を保存します。
Power BI Desktop での接続作成
- Power BI Desktop を開きます。
- データの取得 -> その他を選択します。
- 検索ボックスに CData Paylocity と入力します。
- CData Paylocity コネクタを選択し、接続をクリックします。
- データソース名を入力します(この場合は CData PBI Paylocity Sys)。
- データのコピーをプロジェクトにインポートする場合は インポートを選択します。このデータはオンデマンドで更新できます。または、リモートデータを操作する場合は DirectQuery を選択します。
- ナビゲーターダイアログで必要なテーブルを選択します。読み込みをクリックして Power BI で Paylocity のデータ を表示します。
よくある接続の問題
認証エラー
解決策: 資格情報が最新であることを確認してください。OAuth アプリケーションの場合、アプリケーションのセキュリティ設定で CData を認可する必要がある場合があります。認可のサポートについては [email protected] までお問い合わせください。
サーバーに接続できない
解決策: ファイアウォールとプロキシ設定を確認してください。特定のポート要件については [email protected] までお問い合わせください。
テーブルが見つからない
解決策: データベース名とスキーマ名を確認してください。DSN 設定のデータモデルタブを使用して、利用可能なテーブルを参照してください。
接続に関するその他のトラブルシューティングについては、具体的なエラーメッセージを添えて [email protected] までお問い合わせください。
次のステップ
ドライバーのインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、Power BI Connector をさらに活用してみてください:
| Power BI | 記事タイトル |
|---|---|
| Power BI + Power Apps | 【ノーコード】Power Apps データフローを使ってPaylocity のデータをDataverse に連携する方法 |
| Power BI Dataflow | Power BI データフローでPaylocity のデータを分析用にデータプレパレーション |
| Power BI Dataflows | PowerBI.com でPaylocity Dataflows を作成 |
| Power BI Desktop | 【完全ガイド】Power BI × Paylocity連携 - SQLなしでPaylocityのデータを分析・可視化 |
| Power BI Gateway | Paylocity のデータをリアルタイムでPowerBI.com にパブリッシュ(発行) |
| Power BI Report Builder | Power BI Report Builder でリアルタイムのPaylocity [datatype]を Power BI Service に可視化 |
| Power BI Setup | CData Power BI Connector for Paylocity はじめに:インストールから接続まで |
インストールとライセンス
コネクタのインストールには管理者権限が必要ですか?
はい。CData Power BI Connector のインストールには管理者権限が必要です。インストーラーがシステムディレクトリに書き込み、必要なコンポーネントを登録するためです。
コネクタは 32 ビット版と 64 ビット版の両方がありますか?
いいえ。Power BI Desktop は 64 ビットのみで、すべての CData Power BI Connector は 64 ビット専用の MSI インストーラーとして配布されています。
サポート
ご不明な点がございましたら、お気軽にお問い合わせください:
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
接続
システム DSN とユーザー DSN の違いは何ですか?
システム DSN はマシン上のすべてのユーザーが利用でき、Power BI オンプレミスデータゲートウェイを使用する場合に必要です。ユーザー DSN は作成した Windows ユーザーのみが利用でき、ローカルの Power BI Desktop 使用に適しています。
DSN を作成する代わりに DSN レス接続文字列を使用できますか?
はい。基盤となる ODBC ドライバーは DSN レス接続文字列をサポートしており、Power BI は ODBC コネクタ経由で接続する際に DSN レス設定を使用できます。
例:
Driver={CData Power BI Connector for Paylocity};User=Value1;Password=Value2;SecurityToken=Value3;
(正確なプロパティは Paylocity の認証方法によって異なります。)
複数の Paylocity アカウントに接続するにはどうすればよいですか?
Paylocity アカウントごとに個別の DSN を作成するか、Power BI 内で異なる認証情報を使用して個別の接続エントリを作成します。各 DSN または接続は独自の設定を保存します。
プロキシサーバー経由で接続できますか?
はい。プロキシ設定は DSN の接続プロパティまたは Power BI のコネクタの詳細設定で構成できます。
必要なプロパティとサポートされているプロキシシナリオについては、ドキュメントの Firewall & Proxy セクションを参照してください。
パフォーマンスとトラブルシューティング
クエリが遅いのはなぜですか?
以下を確認してください:
- 大規模なデータセットや複雑な変換を行う場合は、インポートモードを使用してください。インポートモードはデータをローカルにキャッシュし、ライブ API 呼び出しの回数を減らします。
- DirectQuery はリアルタイムデータが必要な場合のみ使用してください。すべてのクエリが Paylocity にリアルタイムで送信されます。
- 読み込み前にデータセットのサイズを削減するため、Power Query でフィルターを適用してください。
- 必要なカラムのサブセットのみ必要な場合は、すべてのカラムを選択しないでください。
- Paylocity API の制限を監視してください。パフォーマンスが制限される場合があります。
- クエリ最適化とベストプラクティスについては [email protected] までお問い合わせください。
トラブルシューティング用のログを有効にするにはどうすればよいですか?
ログは Power BI Desktop のコネクタの詳細接続プロパティで有効にできます。
接続ダイアログで:
- 詳細オプションを展開します
- 以下を設定します:
- Logfile = 書き込み可能なログファイルへのパス
- Verbosity = 3(詳細なログの場合はそれ以上)
分析のために [email protected] にお問い合わせの際は、ログファイルを安全にアップロードしてください。
コネクタにはどのポートへのアクセスが必要ですか?
ほとんどの Paylocity 接続では、アウトバウンド HTTPS(ポート 443)アクセスが必要です。ファイアウォールで Paylocity エンドポイントへのアウトバウンドセキュアトラフィックを許可していることを確認してください。
プロキシや追加のセキュリティレイヤーを使用している環境では、コネクタドキュメントの Firewall & Proxy セクションを参照してください。
コネクタを Linux コンテナや Docker で使用できますか?
いいえ。CData Power BI Connector は Linux コンテナでは使用できません:
- Power BI Desktop は Windows でのみ動作します
- Power BI Gateway は Windows でのみ動作します
- カスタムコネクタ .pqx ファイルは Windows でのみサポートされています
Power BI Connector は Windows 専用のコンポーネントです。
一般
サポートされている SQL 操作の完全なリストはどこで確認できますか?
Paylocity コネクタドキュメントの SQL Compliance セクションを参照してください。 Power BI エンジンの制限により、インポートモードと DirectQuery モードで利用可能な SQL 機能が異なる場合があります。
コネクタはどのくらいの頻度で更新されますか?
CData は Power BI Connector のメジャーアップデートを毎年リリースし、必要に応じて定期的なメンテナンスアップデートを行います。
最新バージョンについては、CData アカウントポータルを確認するか、[email protected] までお問い合わせください。
コネクタの使用例はどこで確認できますか?
ヘルプドキュメントの Power BI Getting Started および Examples セクションを参照してください。
(Note:Power BI Connector は、ODBC ドライバーや JDBC ドライバーのようなプログラミング言語のコードサンプルを使用しません。)
この FAQ で解決しない場合は、[email protected] までお問い合わせください。