Cmdlets for SAP Fieldglass

Build 24.0.9062

接続の確立

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

インストールおよび接続

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

Install-Module SAPFieldglassCmdlets

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

Import-Module SAPFieldglassCmdlets;

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

$conn = Connect-SAPFieldglass -EnvironmentURL "https://myinstance.com" -OAuthClientId "clientId" -OAuthClientSecret "clientSecret" -APIKey "xxxxxxxx-xxxx-xxxx-xxxx"

Obtaining Your Credentials

Please contact your SAP Fieldglass representative to obtain an OAuthClientId, OAuthClientSecret, and EnvironmentURL.

Connecting to SAP Fieldglass

To authenticate to production environments, specify the following:

  • APIKey: Your SAP Fieldglass API Key. To obtain this, log in to the SAP Fieldglass Integration Tools and click Create API Application Key.
  • OAuthClientId: The OAuth Client Id that you obtained from your SAP Fieldglass representative.
  • OAuthClientSecret: OAuth Client Secret that you obtained from your SAP Fieldglass representative.
  • EnvironmentURL: The SAP Fieldglass Environment URL that you obtained from your SAP Fieldglass representative.

データの取得

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"
} 

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062