PowerShell からAcumatica のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData Cmdlets for Acumatica を使えば、PowerShell からAcumatica に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、Acumatica への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

Acumatica への接続を設定

それでは、まずはAcumatica への接続設定からはじめていきましょう。接続設定にはCData Acumatica Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module AcumaticaCmdlets;

Connect-Acumatica コマンドを使ってAcumatica との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-Acumatica  -Url "$Url" -EndpointName "$EndpointName" -EndpointVersion "$EndpointVersion" -User "$User" -Password "$Password" -Company "$Company"

Acumatica 接続プロパティの取得・設定方法

Acumatica への接続

Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。

• URL：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
• Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
• Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
• EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：24.200.001。これはREST スキーマにのみ適用されます。
• EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。

Acumatica への認証

Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。

これで接続設定は完了です。

Acumatica のデータを取得してCSV にパイプライン

接続が完了したので、Events テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-Acumatica -Connection $conn -Table Events | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myEventsData.csv -NoTypeInformation

このコードでは、Select-Acumatica から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-Acumatica -Connection $conn -Table Events -Where "Id = 1" | Remove-Acumatica

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyEventsUpdates.csv | %{
  $record = Select-Acumatica -Connection $Acumatica -Table Events -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Acumatica -Connection $acumatica -Table Events -Columns ("Id","location_displayname") -Values ($_.Id, $_.location_displayname) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Acumatica -Connection $acumatica -Table Events -Columns ("Id","location_displayname") -Values ($_.Id, $_.location_displayname)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのAcumatica のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。