接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でADP Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module ADPCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module ADPCmdlets;

Connect-ADP cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-ADP -InitiateoAuth "GETANDREFRESH" -OAuthClientId "YourClientId" -OAuthClientSecret "YourClientSecret" -SSLClientCert "c:\\cert.pfx" -SSLClientCertPassword="admin@123"

接続の前に

接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。

これらのクレデンシャルはADP からのみ取得可能で、直接取得することはできません。

ADP への接続

次のプロパティを指定してADP に接続します。

OAuthClientId：ADP より提供されたアプリのクライアントId に設定。
OAuthClientSecret：ADP より提供されたアプリのクライアントシークレットに設定。
SSLClientCert：ADP より提供された証明書に設定。
SSLClientCertPassword：証明書のパスワードに設定。
UseUAT：本製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
RowScanDepth：テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。

Note：SSLClientCert は、独自の証明書を作成する必要があります。詳しくは、ADP Developer Resources を参照してください。

データの取得

Select-ADP cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-ADP -Connection $conn -Table "Workers" -Columns @("AssociateOID, WorkerID") -Where "AssociateOID='G3349PZGBADQY8H8'"

Invoke-ADP cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-ADP -Connection $conn -Table Workers -Where "AssociateOID = 'G3349PZGBADQY8H8'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myWorkersData.csv -NoTypeInformation

Select-ADP からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-ADP -InitiateoAuth "GETANDREFRESH" -OAuthClientId "YourClientId" -OAuthClientSecret "YourClientSecret" -SSLClientCert "c:\\cert.pfx" -SSLClientCertPassword="admin@123"
PS C:\> $row = Select-ADP -Connection $conn -Table "Workers" -Columns (AssociateOID, WorkerID) -Where "AssociateOID = 'G3349PZGBADQY8H8'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Workers",
  "Columns":  [

  ],
  "AssociateOID":  "MyAssociateOID",
  "WorkerID":  "MyWorkerID"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-ADP -Connection $conn -Table Workers -Where "AssociateOID = 'G3349PZGBADQY8H8'" | Remove-ADP

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをADP にロードします。

Import-Csv -Path C:\MyWorkersUpdates.csv | %{
  $record = Select-ADP -Connection $conn -Table Workers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ADP -Connection $conn -Table Workers -Columns @("AssociateOID","WorkerID") -Values @($_.AssociateOID, $_.WorkerID) -Where "Id  = `'$_.Id`'"
  }else{
    Add-ADP -Connection $conn -Table Workers -Columns @("AssociateOID","WorkerID") -Values @($_.AssociateOID, $_.WorkerID)
  }
}

Cmdlets for ADP