接続の確立

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

インストールおよび接続

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

Install-Module SAPConcurCmdlets

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

Import-Module SAPConcurCmdlets;

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

$conn = Connect-SAPConcur -OAuthClientId 'abc123' -OAuthClientSecret 'def456'

SAP Concur への認証

SAP Concur はOAuth 認証のみサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

デスクトップアプリケーション

カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

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

InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。
CallbackURL：アプリケーションの登録時に定義されたリダイレクトURI。

接続すると、本製品はデフォルトブラウザでSAP Concur のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

Note： OAuth グラント種別と、デスクトップクライアントアプリケーションがOAuth2 エンドポイントを呼び出してトークンを取得する方法については、この章で後述する「デスクトップ認証グラント種別」を参照してください。

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。以下のいずれかの方法で行います。

オプション1：OAuthVerifier 値を取得します。
オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。以下の手順に従います。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

次のプロパティを設定します。
- InitiateOAuth：OFF。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します。（カスタムOAuth アプリケーションの作成を参照してください。）

このURL をコピーして、新しいブラウザのタブに貼り付けます。
ログインして、本製品にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
- InitiateOAuth：REFRESH。
- OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を指定されたファイルに永続化。
- OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
接続をテストしてOAuth 設定ファイルを生成します。
次のプロパティを再設定して、接続してください。
- InitiateOAuth：REFRESH。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでデータに接続するには、次の接続プロパティを設定します。

InitiateOAuth：REFRESH
OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルへのパス。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

デスクトップ認証グラント種別

トークンを取得するには、クライアントアプリケーションは、必要な認証シナリオに応じ、さまざまなグラントを使用してOauth2 エンドポイントを呼び出す必要があります。CData のドライバーがサポートするシナリオは、CODE とPASSWORD グラント種別です。

CODE

CODE はデフォルトのOAuthGrantType です。前述の設定に加え、CODE グラント種別を使用するには、次の追加設定が必要です。

UseSandbox：実装サーバーを経由して認証している場合は、これをTrue に設定します。
Region：他の資格情報とともに受信した地理位置情報のリージョン。利用可能な値は、EU（ヨーロッパ）、CN（中国）、およびUS（デフォルト）です。

PASSWORD

PASSWORD グラントは、ユーザーとアプリケーションの間に信頼関係がある場合に、デスクトップアプリケーションで使用することができます。

前述の設定に加え、PASSWORD グラント種別を使用するには、次の追加設定が必要です。

AuthScheme：OAuthPassword。
Username：ユーザーネームまたはユーザーId。
Password：ユーザーのパスワード。
UseSandbox：実装サーバーを使用して認証している場合は、これをTrue に設定します。

Company-Level 認証

Company はSAP Concur プラットフォームの最上位プリンシパルです。アクセストークンとリフレッシュトークンは、ユーザーの場合と同じように、Company に代わって取得することができます。

カスタムOAuth アプリケーションの作成の説明に従ってカスタムOAuth アプリケーションを作成したのち、Company Request Token を生成する必要があります。Company Request Token Tool が利用できる場合は、それを使うことができます。そうでない場合は、SAP Concur サポートチームに連絡して、Company Request Token を生成してもらう必要があります。

Company Request Token が正常に生成されると、リクエストトークンツールにCompany UUID とCompany Request Token が表示されます。これらの値は、後で使用するために保存しておきます。

Company-Level 認証を使用する場合、CODE グラント種別を使用するには、前述の設定に加えて次の追加設定が必要です。

AuthScheme：CompanyLevelAuth。
CompanyId：会社固有の識別子。
CompanyRequestToken：生成されたCompany Request Token。
UseSandbox：実装サーバーを使用して認証している場合は、これをTrue に設定します。

SAP Concur ログインID 変数の使用

ログインID（ユーザーのログインID）は、OAuth 2.0 アクセストークンに関連付けられたユーザーアカウントが、以下のロールのいずれかを持つConcur アカウントを持っている場合に使用できます。

Web Services Administrator for Professional
Can Administer for Standard

ログインID をALL に設定すると、Login ID 引数をサポートするすべてのアカウントの情報が取得されます。

データの取得

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

$results = Select-SAPConcur -Connection $conn -Table "Departments" -Columns @("Id, OfficeId") -Where "Id='1668776136772254'"

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

cmdlet 出力のパイプ処理

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

Select-SAPConcur -Connection $conn -Table Departments -Where "Id = '1668776136772254'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDepartmentsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-SAPConcur -OAuthClientId 'abc123' -OAuthClientSecret 'def456'
PS C:\> $row = Select-SAPConcur -Connection $conn -Table "Departments" -Columns (Id, OfficeId) -Where "Id = '1668776136772254'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Departments",
  "Columns":  [

  ],
  "Id":  "MyId",
  "OfficeId":  "MyOfficeId"
}

データの削除

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

Select-SAPConcur -Connection $conn -Table Departments -Where "Id = '1668776136772254'" | Remove-SAPConcur

データの変更

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

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

Cmdlets for SAP Concur