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

Somya Sharma
Somya Sharma
Technical Marketing Engineer
Paylocity PowerShell Cmdlets のインストール、ライセンス認証、接続設定の完全ガイドです。

このガイドでは、Paylocity PowerShell Cmdlets の使い方を詳しく解説します。Cmdlet のインストール、初回接続の設定、クエリの実行、そして PowerShell で Paylocity のデータ を操作するための次のステップをご紹介します。

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

システム要件

CData PowerShell Cmdlets は、PowerShell が動作するあらゆる環境で実行できます。

Windows

  • Windows 10/11
  • Windows Server 2016 以降
  • PowerShell 5.1 または PowerShell 7 以降

macOS / Linux

  • PowerShell 7 以降
  • 追加のシステムライブラリは不要
  • アーキテクチャ固有のインストーラーは不要

Cmdlet のインストール

CData Cmdlets は PowerShell Gallery から配布されており、プラットフォーム間で簡単かつ一貫したインストールプロセスを実現しています。

インストール手順

  1. 管理者モードで PowerShell を開きます
  2. 以下のコマンドを実行して Cmdlet モジュールをインストールします： 
    Install-Module PaylocityCmdlets -Repository PSGallery -Force

    このコマンドは：

    • 公式の PowerShell Gallery からモジュールをダウンロードします
    • PowerShell 環境にインストールします
    • すべての Cmdlet をすぐに使用できるように登録します

モジュールの確認

インストールを確認するには： 

Get-Module -ListAvailable "*Paylocity*"

ライセンス認証

Cmdlets は試用版と正規ライセンスの両方の認証に対応しています。

試用版ライセンス

試用版の認証は自動的に行われ、キーは不要です。インストール後すぐに Cmdlet を使用できます。

正規ライセンスの認証

正規ライセンスを購入された場合、CData Orders チームからプロダクトキーを受け取ります。

ライセンスの認証

以下のコマンドを実行します：

Set-ModuleLicense ""

認証が成功すると、確認メッセージが表示されます。

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

ライセンスは複数のマシンで使用できますか？

サブスクリプションプランによります。注文確認メールを確認するか、[email protected] までお問い合わせください。

ライセンスキーを紛失しました。どうすればよいですか？

注文番号を添えて [email protected] までメールでお問い合わせください。

ライセンスを別のマシンに移行できますか？

以下のリンクからライセンス移行リクエストを送信してください：https://www.cdata.com/lic/transfer/

ライセンスはどこで管理できますか？

CData カスタマーポータルにアクセスしてください：https://portal.cdata.com/

接続設定

モジュールがインストールされ、ライセンスが認証されたら、

Connect-Paylocity cmdlet
を使用して Paylocity への接続を確立できます。

必要な接続プロパティを取得したら、PowerShell で Paylocity のデータ にアクセスしてレプリケーションを準備するには、基本的に 4 つのステップがあります。

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 のデータ の取得

  1. モジュールをインストールします： 

    Install-Module PaylocityCmdlets

  2. Paylocity に接続します： 

      $paylocity = Connect-Paylocity  -OAuthClientID $OAuthClientID -OAuthClientSecret $OAuthClientSecret -RSAPublicKey $RSAPublicKey -Key $Key -IV $IV

PowerShell での Paylocity のデータ のクエリ

接続後、標準 SQL のようなコマンドを使用してデータをクエリできます。

クエリ例：

$results = Select-Paylocity `
    -Connection $conn `
    -Table "Employee" `
    -Columns "FirstName,LastName" `
    -Where "FirstName != ''"

結果を表示します：

$results

これで PowerShell から Paylocity のデータ にアクセスできるようになりました。

よくある問題

認証エラー

解決策： ユーザー名、パスワード、セキュリティトークンを確認してください。OAuth アプリケーションの場合、アプリケーションのセキュリティ設定で CData を認可する必要がある場合があります。認可のサポートについては [email protected] までお問い合わせください。

ネットワークまたはプロキシの問題

解決策： ファイアウォール設定とアウトバウンドアクセスを確認してください。ほとんどのクラウドアプリケーションはポート 443 を使用します。

Cmdlet が見つからない

解決策： モジュールがインストールされていることを確認してください - 

Get-Module -ListAvailable "*Paylocity*"

クエリが遅い

解決策：

  • フィルターを追加してデータセットのサイズを削減してください
  • サポートされている場合は $Limit または $Top プロパティを使用してください
  • 最適化のサポートについては [email protected] までお問い合わせください

接続に関するその他のトラブルシューティングについては、具体的なエラーメッセージを添えて [email protected] までお問い合わせください。

次のステップ

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

PowerShell記事タイトル
Piping CmdletsPowerShell で Paylocity のデータ を CSV にパイプする方法
ReplicationPowerShell スクリプトで Paylocity のデータ を MySQL にレプリケートする

サポート

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

FAQ（PowerShell Cmdlets）

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

  • Cmdlet のインストールには管理者権限が必要ですか？

    • 必ずしも必要ではありません。

    • Windows PowerShell 5.1（Windows）：管理者権限が推奨されます。特にすべてのユーザー向けにモジュールをインストールする場合に必要です。
    • PowerShell 7 以降（Windows、macOS、Linux）：以下のコマンドを使用することで、管理者権限なしで現在のユーザー向けに Cmdlet をインストールできます： 
      Install-Module PaylocityCmdlets -Scope CurrentUser
  • インストーラーをダウンロードする必要がありますか？

    • CData PowerShell Cmdlets は PowerShell Gallery から配布されています。インストールは以下のコマンドで実行します：

    Install-Module PaylocityCmdlets -Repository PSGallery -Force

接続

  • 同じデータソースの複数のアカウントに接続するにはどうすればよいですか？

    • 異なる認証プロパティを持つ個別の接続オブジェクトを作成します：

    $conn1 = Connect-Paylocity -User User1 -Password Pwd1
    $conn2 = Connect-Paylocity -User User2 -Password Pwd2
  • PowerShell Cmdlets には DSN が必要ですか？

    • Cmdlet は ODBC DSN を使用しません。すべての接続プロパティは 

    Connect-Paylocity
    で直接渡されます。

  • プロキシサーバー経由で接続できますか？

    • 多くの Cmdlet は以下のようなプロキシプロパティをサポートしています：

    • ProxyServer
    • ProxyPort
    • ProxyUser
    • ProxyPassword

    データソース固有のヘルプドキュメントを参照してください。

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

  • クエリが遅いのはなぜですか？

    • よくある原因：

    • フィルターがない（WHERE 句がない）
    • 大量の結果セットを取得している
    • クラウド API からのレイテンシ
    • 増分戦略を使用していない

    以下をお試しください：

    • データをフィルタリングする（-Where パラメータ）
    • 必要なカラムのみを選択する
    • データソースの API スロットリング制限を確認する

    クエリ最適化のサポートについては [email protected] までお問い合わせください。

  • ログを有効にするにはどうすればよいですか？

    • 以下のコマンドでモジュールのログを有効にします：

    Set-ModuleLogging -Path "C:\logs\cdata.log" -Verbosity 3
    CData サポートと連携する際は、ログファイルを安全にアップロードしてください。

  • どのポートを開放する必要がありますか？

    • ほとんどのクラウドアプリケーション（Salesforce、HubSpot、Dynamics、Google API など）は HTTPS（443）を使用します。

    ソースが追加のポートを必要とする場合は、固有のドキュメントを確認するか、[email protected] までお問い合わせください。

  • コンテナ（Docker、Kubernetes）で Cmdlet を使用できますか？

    • コンテナに PowerShell 7 をインストールし、モジュールをインストールします：

    pwsh -Command "Install-Module PaylocityCmdlets -Force"
    その後、通常どおり認証を行います。

一般

  • サポートされているすべての SQL/コマンド操作はどこで確認できますか？

    • 各 Cmdlet にはローカルにインストールされたヘルプドキュメントが含まれており、オンラインでも参照可能です：https://www.cdata.com/powershell/

  • PowerShell Cmdlets はどのくらいの頻度で更新されますか？

    • CData はメジャーアップデートを年次でリリースし、年間を通じて増分アップデートを行います。バージョンの入手可能性については、カスタマーポータルを確認するか、[email protected] までお問い合わせください。

  • コード例はどこで確認できますか？

    • すべての Cmdlet にはヘルプドキュメントに例が含まれており、多くのサービスのオンライン例も提供されています：https://www.cdata.com/powershell/ 例には以下が含まれます：

    • 基本的なクエリ
    • Insert/Update/Delete
    • OAuth フロー
    • ファイル操作
    • API 連携

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

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

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

 ダウンロード

詳細：

Paylocity Icon Paylocity Data Cmdlets お問い合わせ

Paylocity データにリアルタイム連携を実現するPowerShell Cmdlets。Cmdlets を使って、SQL Server と同感覚で多様なデータにリアルタイムアクセスを実現。

この記事の内容

関連記事