各製品の資料を入手。
詳細はこちら →
製品をチェック
PowerShell からNetSuite のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法
CData PowerShell Cmdlets を使って、NetSuite のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるNetSuite 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
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 -Account Id "$Account Id" -Password "$Password" -User "$User" -Role Id "$Role Id" -Version "$Version"
Netsuite への接続
NetSuite は現在、2つの異なるAPI を提供しています。
- SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。 しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、 そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
- SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。 加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。
NetSuite に接続するには、以下を行う必要があります。
- Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
- 使用するAPI に適した接続オプションを設定します。（それぞれのAPI で利用可能な接続オプションが異なります。ヘルプドキュメントの「許可の設定」を参照してください。）
Netsuite への認証
SuiteTalk またはSuiteQL
NetSuite は3つの形式のOAuth 認証を提供します。
- トークンベース認証（TBA）は、基本的にOAuth 1.0 で、OAuthAccessToken とOAuthAccessTokenSecret を実行時ではなくNetSuite UI 内で作成します。 TBA は、2020.2 以降のSuiteTalk およびSuiteQL の両方で利用可能です。
- OAuth 2.0 認証は、SuiteQL でのみ利用できます。OAuth 2.0 認証を強制するには、次のいずれかを実行します。
- OAuthVersion を使用するAPI に明示的に設定、または
- Schema をSuiteQL に設定
- OAuth JWT 認証は、OAuth 2.0 クライアント認証フローであり、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。この認証方法は、Schema がSuiteQL に設定されている場合にのみ使用できます。
認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。
これで接続設定は完了です。
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日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。
関連コンテンツ
