CData ADO.NET Provider for Paylocity はじめに：インストールから接続まで

このガイドでは、CData ADO.NET Provider for Paylocity の使い方を詳しく解説します。プロバイダーのインストール、Paylocity のデータ への接続設定、そして .NET アプリケーションで ADO.NET パターンを使用した簡単なコマンドの実行方法を学べます。

デスクトップアプリ、Web アプリ、バックグラウンドサービスなど、どのような用途でも、このプロバイダーを使えば API の詳細を手動で管理することなく、ライブの Paylocity のデータ に安全かつ高パフォーマンスで接続できます。

インストールとライセンス認証

システム要件

• Windows： Windows 10/11 または Windows Server 2016 以降
• .NET バージョン： .NET Framework 4.0 以降、.NET 6 以降、.NET Standard アセンブリ
• IDE： Visual Studio 2017 以降

ADO.NET Provider のインストール

Windows でのインストール

1. CData アカウントまたは評価版ダウンロードページから ADO.NET Provider インストーラーをダウンロードします。
2. インストーラーを実行し、ウィザードに従ってインストールを完了します。
3. インストーラーがプロバイダーを登録し、すべてのアセンブリを適切な CData インストールフォルダに配置します。
4. インストール中にライセンスキーの入力を求められます：
   XXXX-XXXX-XXXX-XXXX-XXXX
   • Note： 試用版を使用する場合は、代わりにTrial Key を選択してください。

ライセンスの認証

ライセンスの動作は、.NET Framework と .NET Standard のどちらを使用しているかによって異なります。 以下の手順で、お使いの環境でプロバイダーを認証してください。

.NET Framework（Windows）

Windows で .NET Framework を使用する場合、追加の操作は必要ありません。インストーラーまたは NuGet パッケージが開発ライセンスを自動的にインストールします。

.NET Standard（Windows/Mac/Linux）

.NET Core、Mono、Xamarin などの .NET Standard プラットフォームでは、プロバイダーを使用する前に手動でライセンスをインストールする必要があります。

Install-License ツールの使用

ツールキットには、試用版または正規ライセンスを適用するための install-license ユーティリティが

lib/netstandard2.0

試用版ライセンスをインストールする場合：

dotnet ./install-license.dll

正規版ライセンスを認証する場合：

dotnet ./install-license.dll 

ツールを実行すると、開発マシンがライセンス認証され、.NET アプリケーションでプロバイダーを使用できるようになります。

ランタイムライセンス

アプリケーションをデプロイする際は、接続文字列でランタイムキー（RTK）を指定して再配布を有効にします。

ライセンスに関するよくある質問

ライセンスは複数のマシンで使用できますか？
はい、サブスクリプションプランによります。不明な場合は、注文確認メールを確認するか、[email protected] までお問い合わせください。

ライセンスキーを紛失しました。どうすれば取得できますか？
注文番号を添えて [email protected] までメールでお問い合わせください。

ライセンスを別のマシンに移行できますか？
ライセンス移行リクエストを送信してください：
https://www.cdata.com/lic/transfer/

承認されると、プロダクトキーにアクティベーションが追加され、以前のインストールは無効になります。

ライセンスサポートの詳細については、portal.cdata.com にアクセスするか、[email protected] までお問い合わせください。

接続設定

インストールが完了したら、次のステップとして Paylocity への接続を設定します。接続は、.NET アプリケーションのコードまたは構成ファイルで ADO.NET 接続文字列を使用して作成します。

接続マネージャーの作成

• Visual Studio を開きます。
• 表示メニューからサーバー エクスプローラーを選択します。
• 左サイドバーからデータベースへの接続をクリックします。
• 接続の追加ダイアログで、変更をクリックします。
• CData Paylocity のデータ source を選択し、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 を設定することを意味します。

接続テスト

• 接続テストをクリックします。

• 接続に成功すると、Visual Studio 内でデータを確認できます。

よくある接続の問題

認証エラー

解決策： Paylocity の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。サポートが必要な場合は [email protected] までお問い合わせください。

サーバーに接続できない

解決策： ファイアウォール、プロキシ、VPN の設定を確認してください。必要なポート情報については [email protected] までお問い合わせください。

テーブルが見つからない

解決策： Paylocity をクエリする際に、正しいスキーマまたはデータベースを選択しているか確認してください。

次のステップ

ADO.NET Provider のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、ADO.NET ツールをさらに活用してみてください：

サポート

ご不明な点がございましたら、お気軽にお問い合わせください：

• テクニカルサポート： [email protected]
• コミュニティフォーラム： CData Community Site
• ヘルプドキュメント： ローカルにインストールされているほか、オンラインでも参照可能です

FAQ

インストールとライセンス

• ADO.NET Provider のインストールには管理者権限が必要ですか？
  はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。
• Azure Data Factory にデプロイする際に RTK は必要ですか？
  はい。アプリケーションの接続文字列で RTK プロパティを設定してから公開してください。

接続

• 複数の Paylocity アカウントを使用できますか？
  アカウントごとに個別の接続文字列を作成してください。
• プロキシ経由で接続できますか？
  はい。接続文字列でプロキシ設定を構成できます。
• 接続をテストするにはどうすればよいですか？
  接続マネージャー UI で接続テストをクリックしてください。

パフォーマンスとトラブルシューティング

• クエリのパフォーマンスを改善するにはどうすればよいですか？
  フィルターの適用、行数の制限、サーバー側のページングプロパティの活用をお試しください。
• ログを有効にするにはどうすればよいですか？
  接続マネージャーに以下を追加してください：
  • Logfile: /path/to/logfile.log
  • Verbosity: 3

  トラブルシューティングの際は、[email protected] にご連絡の上、ログファイルを安全にアップロードしてください。

  この FAQ で解決しない場合は、[email protected] までお問い合わせください。