接続の確立
CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でSAPFieldglass Cmdlets を使用する例を示します。
資格情報の取得
SAP Fieldglass の担当者に問い合わせ、OAuthClientId、OAuthClientSecret、EnvironmentURL を入手してください。
SAP Fieldglass への接続
運用環境への認証を行うには、以下のように指定します。
- APIKey:SAP Fieldglass API キー。これはオプションですが、API キーが必要であることを示すSAP Fieldglass からのエラーが発生した場合は、SAP Fieldglass 管理者に依頼するか、SAP Fieldglass Integration Tools にログインしてCreate API Application をクリックします。
- OAuthClientId:SAP Fieldglass 担当者から取得したOAuth Client ID。
- OAuthClientSecret:SAP Fieldglass 担当者から取得したOAuth Client Secret。
- EnvironmentURL:SAP Fieldglass 担当者から取得したSAP Fieldglass Environment URL。
接続オブジェクトの作成
Connect-SAPFieldglass cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。
$conn = Connect-SAPFieldglass -EnvironmentURL "https://myinstance.com" -OAuthClientId "clientId" -OAuthClientSecret "clientSecret" -APIKey "xxxxxxxx-xxxx-xxxx-xxxx"
データの取得
Select-SAPFieldglass cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。
$results = Select-SAPFieldglass -Connection $conn -Table "AuditTrails" -Columns @("Id, Category") -Where "Company='CData'"
Invoke-SAPFieldglass cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。
cmdlet 出力のパイプ処理
cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。
Select-SAPFieldglass -Connection $conn -Table AuditTrails -Where "Company = 'CData'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAuditTrailsData.csv -NoTypeInformation
Select-SAPFieldglass からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。
ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。
PS C:\> $conn = Connect-SAPFieldglass -EnvironmentURL "https://myinstance.com" -OAuthClientId "clientId" -OAuthClientSecret "clientSecret" -APIKey "xxxxxxxx-xxxx-xxxx-xxxx"
PS C:\> $row = Select-SAPFieldglass -Connection $conn -Table "AuditTrails" -Columns (Id, Category) -Where "Company = 'CData'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
"Connection": {
},
"Table": "AuditTrails",
"Columns": [
],
"Id": "MyId",
"Category": "MyCategory"
}