CData SSIS Components for Paylocity はじめに：インストールから接続まで

CData SSIS Components for Paylocity のインストール、ライセンス認証、接続設定の完全ガイドです。

このガイドでは、CData SSIS Components for Paylocity の使い方を詳しく解説します。コンポーネントのインストール、ライセンスの認証、初回 SSIS 接続マネージャーの設定、そして SQL Server Integration Services ワークフローで Paylocity のデータ を移動・変換するためのデータフロータスクの作成方法を学べます。

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

システム要件

  • Windows： Windows 10/11 または Windows Server 2016 以降
  • Visual Studio： Visual Studio 2015 以降
  • SQL Server： SQL Server 2014、2016、2017、2019、または 2022

SSIS コンポーネントのインストール

  1. CData アカウントまたは評価版ダウンロードページから Paylocity 用の SSIS Components インストーラーをダウンロードします
  2. インストーラーを実行し、インストールウィザードに従います
  3. インストーラーが自動的に接続マネージャー、ソース、宛先コンポーネントを Visual Studio に登録します
  4. プロンプトが表示されたら、CData Orders チームから送られたプロダクトキーを使用してライセンスを認証します：
    XXXX-XXXX-XXXX-XXXX-XXXX
    • Note： 試用版を実行するには、Trial Key オプションを選択してください。

Visual Studio 2022 での SSIS の有効化

Visual Studio 2022 を使用している場合は、SQL Server Integration Services Projects 拡張機能をインストールする必要があります。

  1. Visual Studio で 拡張機能 > 拡張機能の管理 を選択します
  2. SQL Server Integration Services Projects 2022 を検索します
  3. インストールをクリックします
  4. Visual Studio を閉じ、ダウンロードした Microsoft.DataTools.IntegrationServices.exe インストーラーを実行します
  5. Visual Studio を再度開きます。新しいプロジェクトを作成する際に Integration Services Project テンプレートが表示されるようになります

ライセンスの認証

インストール中に SSIS Component ライセンスの認証が求められます。認証を更新または変更する必要がある場合は、以下の手順に従ってください：

ライセンス認証

インストーラーが自動的にライセンスの追加を促します。インストール時に以下を選択できます：

  • 既存のサブスクリプションライセンスキーを使用する、または
  • 試用版ライセンスを入力する

正規サブスクリプションライセンスを認証するには、CData Orders チームにお問い合わせいただき、[email protected] でプロダクトキーをリクエストしてください。

プロンプトが表示されたら、インストーラーにライセンスキーを入力します。認証が完了すると、追加の手順なしに Visual Studio 内でコンポーネントがライセンス認証され、使用できるようになります。

ランタイムライセンス

SSIS パッケージをデプロイする際は、ランタイムキー（RTK）も使用できます：

  • デプロイ前に接続マネージャーで RTK プロパティを設定します

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

ライセンスは複数のマシンで使用できますか？
はい、サブスクリプションプランによります。詳細については [email protected] までお問い合わせください。

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

ライセンスを別のマシンに移行するにはどうすればよいですか？

はい。ライセンスを別のマシンに移行するには、以下のリンクからライセンス移行リクエストを送信する必要があります：

https://www.cdata.com/lic/transfer/

ライセンス移行リクエストが送信され、正常に処理されると、プロダクトキーにアクティベーションが追加され、別のマシンで正規ライセンスを認証できるようになります。このプロセスが完了すると、以前のマシンのライセンスは無効になります。

ライセンスの確認とアップグレードは、セルフサービスポータル portal.cdata.com から行えます。

接続設定

コンポーネントがインストールされ、ライセンスが認証されたら、SSIS 接続マネージャーを使用して Paylocity への接続を設定できます。この接続マネージャーは、ソースおよび宛先コンポーネントで使用されるすべての認証および接続プロパティを保存します。

接続マネージャーの作成

  1. SSIS パッケージの下部にある接続マネージャーパネルで右クリックし、新しい接続を選択します
  2. リストから CData SSIS Components for Paylocity を選択します
  3. 追加をクリックして接続マネージャー UI を開きます
  4. Paylocity に応じて必要な認証プロパティ（OAuth、API トークン、クライアント資格情報など）を入力します

    5. 接続プロパティの設定

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

  5. 接続テストをクリックして接続を確認します

SSIS データフローの作成

接続マネージャーを作成したら、SSIS データフロータスクを使用して Paylocity からデータを取得したり、データをプッシュしたりできます。

データフロータスクの作成

  1. 制御フロータブで、データフロータスクをデザインサーフェスにドラッグします
  2. タスクをダブルクリックしてデータフローワークスペースを開きます

ソースコンポーネントの使用

  1. SSIS ツールボックスから、CData Paylocity Source コンポーネントをデータフローにドラッグします
  2. ダブルクリックしてソースエディターを開きます
  3. 作成した CData Paylocity 接続マネージャーを選択します
  4. レコードを抽出するテーブルまたはビューを選択します
  5. OK をクリックして設定を保存します

宛先コンポーネントの使用

  1. SQL Server 宛先をキャンバスにドラッグします
  2. ダブルクリックして宛先エディターを開きます
  3. 既存のテーブルを選択するか、新規をクリックしてソースのスキーマに基づいてテーブルを自動生成します
  4. ソースの出力を宛先の入力に接続し、必要に応じてカラムをマッピングします
  5. これで Paylocity のデータ を SQL Server データベースにレプリケートするデータフロータスクが作成されました

データフローのテスト

  1. 制御フロータブに戻ります
  2. デバッグの開始をクリックします
  3. 進行状況インジケーターを監視します
  4. 行数を確認し、データが期待どおりに読み込まれていることを確認します

よくある接続の問題

認証エラー

解決策： Paylocity の OAuth 設定、クライアント ID、シークレット、またはトークンの権限を確認してください。OAuth のトラブルシューティングについては [email protected] までお問い合わせください。

サーバーに接続できない

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

テーブルが見つからない

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

次のステップ

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

SSIS Component記事タイトル

サポート

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

FAQ

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

  • SSIS Components のインストールには管理者権限が必要ですか？
    はい、Visual Studio 全体で使用するコンポーネントをインストールするには管理者権限が必要です。
  • Azure Data Factory にデプロイする際に RTK は必要ですか？
    はい。公開前に接続マネージャーで RTK プロパティを設定してください。

接続

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

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

  • データフローが遅いのはなぜですか？
    フィルターの追加、行数の制限、ソースコンポーネントでのバッチ処理設定を確認してください。
  • ログを有効にするにはどうすればよいですか？
    接続マネージャーに以下を追加してください：
    • Logfile: /path/to/logfile.log
    • Verbosity: 3

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

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

はじめる準備はできましたか？

Paylocity SSIS Component の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Paylocity Icon Paylocity SSIS Components お問い合わせ

パワフルなSSIS Source & Destination Components で、SQL Server とPaylocity データをSSIS ワークフローで連携。:Paylocity Data Flow Components を使って、多様なデータを簡単に同期。データ同期、ローカルバックアップ、ワークフロー自動化に最適！

この記事の内容

関連記事