接続の確立

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

Epicor Kinetic への接続

ERP インスタンスに正常に接続するには、次の接続プロパティを指定する必要があります。

URL：ERP インスタンスをホストするサーバーのURL に設定。例：https://myserver.EpicorSaaS.com
ERPInstance：ERP インスタンスの名前に設定。
User：アカウントのユーザー名に設定。
Password：アカウントのパスワードに設定。
Service：データを取得するサービスに設定。例：BaqSvc

さらに、オプションの接続プロパティを設定することもできます。

ApiKey：アカウントの構成によっては、一部のサービスへの接続に必要になる場合があるオプションのキー。
ApiVersion：デフォルトはv1。新しいEpicor API を使用するためにv2に設定することができます。
Company：ApiVersion をv2に設定した場合は必須。

Epicor Kinetic への認証

Microsoft Entra ID（Azure AD）を使用したOpenID

Note：Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

Entra ID（Azure AD）のOpenID Connect は、OAuth を経由する接続タイプです。

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

下記の手順に従って、カスタムOAuth アプリケーションの資格情報を使用して認証します。 Entra ID（Azure AD）アプリケーションの作成を参照してください。

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

以下の接続プロパティグループのいずれかを設定すると、接続できるようになります。

クライアントシークレットを使用した認証
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- CallbackURL：アプリケーション設定のリダイレクトURL に設定。
証明書を使用した認証
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthJWTCert：JWT 証明書ストアに設定。
- OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。
- CallbackURL：アプリケーション設定のリダイレクトURL に設定。

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

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下の2つのオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：別のマシンに本製品をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品を設定します。

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

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、Epicor Kinetic OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

InitiateOAuth：REFRESH に設定。
OAuthVerifier：verifier code に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：ドライバーがOAuth トークン値を保存するファイルの場所に設定。これは接続間で維持されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

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

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

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

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

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

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

接続オブジェクトの作成

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

$conn = Connect-EpicorERP -Service 'Erp.BO.CustomerSvc' -ERPInstance 'MyInstance' -URL 'https://myaccount.epicorsaas.com' -User 'username' -Password 'password'

データの取得

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

$results = Select-EpicorERP -Connection $conn -Table "Customers" -Columns @("CustNum, Company") -Where "CompanyName='CompanyName'"

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

cmdlet 出力のパイプ処理

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

Select-EpicorERP -Connection $conn -Table Customers -Where "CompanyName <> 'CompanyName'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-EpicorERP -Service 'Erp.BO.CustomerSvc' -ERPInstance 'MyInstance' -URL 'https://myaccount.epicorsaas.com' -User 'username' -Password 'password'
PS C:\> $row = Select-EpicorERP -Connection $conn -Table "Customers" -Columns (CustNum, Company) -Where "CompanyName <> 'CompanyName'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "CustNum":  "MyCustNum",
  "Company":  "MyCompany"
}

データの削除

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

Select-EpicorERP -Connection $conn -Table Customers -Where "CompanyName = 'CompanyName'" | Remove-EpicorERP

データの変更

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

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

Cmdlets for Epicor Kinetic