Cmdlets for SAP Ariba Procurement

Build 24.0.9062

接続の確立

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

インストールおよび接続

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

Install-Module SAPAribaProcurementCmdlets

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

Import-Module SAPAribaProcurementCmdlets;

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

$conn = Connect-SAPAribaProcurement -ANID "AN02000000280" -API "PurchaseOrdersBuyerAPI-V1" -APIKey "wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU" -AuthScheme "OAuthClient" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "testClient" -OAuthClientSecret "testClientSecret" -UseSandbox "false"

SAP Ariba への接続

接続するには以下を設定します。

  • ANID：Ariba Network ID。
  • API：本製品 にSAP Ariba データを取得させたいAPI を指定。ビジネスロールに基づき、Buyer またはSupplier API を選択します。
  • Environment：接続に使用する開発環境。

SAP Ariba への認証

SAP Ariba API への認証はOAuth 経由で行われます。SAP Ariba のOAuth フローは、ユーザーインタラクションを必要としません。

OAuthClient

AuthScheme をOAuthClient に設定します。

サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。

アプリケーションの作成については、カスタムOAuth アプリの作成 を参照してください。

InitiateOAuth のデフォルトは、OAuthClient 認証スキームのGETANDREFRESH です。

OAuth の自動リフレッシュ

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • APIKey：アプリケーション設定のApplication key。
  • OAuthClientId：アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret：アプリケーション設定のOAuth Secret。

接続すると、本製品 は自動でOAuth プロセスを完了します。

  1. 本製品 はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
  2. 本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。
  3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます。

OAuth の手動リフレッシュ

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • APIKey：アプリケーション設定のApplication key。
  • OAuthClientId：アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret：アプリケーション設定のOAuth Secret。

次に、GetOAuthAccessToken ストアドプロシージャを呼び出します。GrantType インプットをclient_credentials またはopenapi_2lo（レガシーユーザーで利用可能）に設定します。指定されていない場合、GrantType のデフォルトはclient_credentials になります。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

  • InitiateOAuth：REFRESH。
  • APIKey：アプリケーション設定のApplication key。
  • OAuthClientId：アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret：アプリケーション設定のOAuth Secret。
  • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
  • OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークン。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

  • APIKey：アプリケーション設定のApplication key。
  • OAuthClientId：アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret：アプリケーション設定のOAuth Secret。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

データの取得

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

$results = Select-SAPAribaProcurement -Connection $conn -Table "Orders" -Columns @("DocumentNumber, Revision") -Where "VendorId='v1'"
Invoke-SAPAribaProcurement cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-SAPAribaProcurement -Connection $conn -Table Orders -Where "VendorId = 'v1'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-SAPAribaProcurement -ANID "AN02000000280" -API "PurchaseOrdersBuyerAPI-V1" -APIKey "wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU" -AuthScheme "OAuthClient" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "testClient" -OAuthClientSecret "testClientSecret" -UseSandbox "false"
PS C:\> $row = Select-SAPAribaProcurement -Connection $conn -Table "Orders" -Columns (DocumentNumber, Revision) -Where "VendorId = 'v1'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Orders",
  "Columns":  [

  ],
  "DocumentNumber":  "MyDocumentNumber",
  "Revision":  "MyRevision"
}

データの削除

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

Select-SAPAribaProcurement -Connection $conn -Table Orders -Where "VendorId = 'v1'" | Remove-SAPAribaProcurement

データの変更

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

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-SAPAribaProcurement -Connection $conn -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SAPAribaProcurement -Connection $conn -Table Orders -Columns @("DocumentNumber","Revision") -Values @($_.DocumentNumber, $_.Revision) -Where "Id  = `'$_.Id`'"
  }else{
    Add-SAPAribaProcurement -Connection $conn -Table Orders -Columns @("DocumentNumber","Revision") -Values @($_.DocumentNumber, $_.Revision)
  }
}

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