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

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

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

NetSuite への接続を設定

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

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

    Import-Module NetSuiteCmdlets;

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

    $conn = Connect-NetSuite  -AccountId "$AccountId" -Schema "$Schema" -AuthScheme "$AuthScheme" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -OAuthAccessToken "$OAuthAccessToken" -OAuthAccessTokenSecret "$OAuthAccessTokenSecret"

NetSuiteへの接続

NetSuite では、2種類のAPI でデータにアクセスできます。どちらのAPI を使用するかは、Schema 接続プロパティで以下のいずれかを選択して指定してください。

• SuiteTalk は、NetSuite との通信に使用されるSOAP ベースの従来から提供されているサービスです。幅広いエンティティをサポートし、INSERT / UPDATE / DELETE の操作も対応しています。ただし、SuiteQL API と比べるとデータの取得速度が劣ります。また、サーバーサイドでのJOIN に対応していないため、これらの処理はCData 製品がクライアントサイドで実行します。
• SuiteQL は、より新しいAPI です。JOIN、GROUP BY、集計、カラムフィルタリングをサーバーサイドで処理できるため、SuiteTalk よりもはるかに高速にデータを取得できます。ただし、NetSuite データへのアクセスは読み取り専用となります。

データの取得のみが目的でしたらSuiteQL をお勧めします。データの取得と変更の両方が必要な場合は、SuiteTalk をお選びください。

NetSuite への認証

CData 製品では、以下の認証方式がご利用いただけます。

• トークンベース認証（TBA）はOAuth1.0に似た仕組みです。2020.2以降のSuiteTalk とSuiteQL の両方で利用できます。
• OAuth 2.0 認証（OAuth 2.0 認可コードグラントフロー）は、SuiteQL でのみご利用いただけます。
• OAuth JWT 認証は、OAuth2.0 クライアント認証フローの一つで、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。

トークンベース認証（OAuth1.0）

トークンベース認証（TBA）は、基本的にOAuth 1.0 の仕組みです。この認証方式はSuiteTalk とSuiteQL の両方でサポートされています。管理者権限をお持ちの方がNetSuite UI 内でOAuthClientId、OAuthClientSecret、OAuthAccessToken、OAuthAccessTokenSecret を直接作成することで設定できます。 NetSuite UI でのトークン作成手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。

アクセストークンを作成したら、以下の接続プロパティを設定して接続してみましょう。

• AuthScheme = Token
• AccountId = 接続先のアカウント
• OAuthClientId = アプリケーション作成時に表示されるコンシューマーキー
• OAuthClientSecret = アプリケーション作成時に表示されるコンシューマーシークレット
• OAuthAccessToken = アクセストークン作成時のトークンID
• OAuthAccessTokenSecret = アクセストークン作成時のトークンシークレット

その他の認証方法については、ヘルプドキュメントの「はじめに」をご確認ください。

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

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

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

Select-NetSuite -Connection $conn -Table SalesOrder | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySalesOrderData.csv -NoTypeInformation

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

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

データの削除

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

Select-NetSuite -Connection $conn -Table SalesOrder -Where "Class_Name = Furniture : Office" | Remove-NetSuite

データの挿入と更新

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

Import-Csv -Path C:\MySalesOrderUpdates.csv | %{
  $record = Select-NetSuite -Connection $NetSuite -Table SalesOrder -Where ("InternalId = `'"+$_.InternalId+"`'")
  if($record){
    Update-NetSuite -Connection $netsuite -Table SalesOrder -Columns ("CustomerName","SalesOrderTotal") -Values ($_.CustomerName, $_.SalesOrderTotal) -Where ("InternalId = `'"+$_.InternalId+"`'")
  }else{
    Add-NetSuite -Connection $netsuite -Table SalesOrder -Columns ("CustomerName","SalesOrderTotal") -Values ($_.CustomerName, $_.SalesOrderTotal)
  }
}

おわりに

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