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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Exact Online への接続を設定

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

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

    Import-Module ExactOnlineCmdlets;

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

    $conn = Connect-ExactOnline  -Region "$Region" -Division "$Division"

Exact Online はOAuth 認証標準を使用します。InitiateOAuth 接続プロパティはOAuth フローを容易にします。デフォルトではGETANDREFRESH です。埋め込みクレデンシャルを使用する、またはExact にOAuth アプリを登録して独自のクレデンシャルを取得することもできます。 OAuth 値に加え、Region を指定します。Division が設定されない場合は、デフォルトのDivision が使用されます。

詳しくは、ヘルプドキュメントの「はじめに」を参照してください。

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

Exact Online データを取得してCSV にパイプライン

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

Select-ExactOnline -Connection $conn -Table Accounts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

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

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

データの削除

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

Select-ExactOnline -Connection $conn -Table Accounts -Where "IsCompetitor = False" | Remove-ExactOnline

データの挿入と更新

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

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
  $record = Select-ExactOnline -Connection $ExactOnline -Table Accounts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ExactOnline -Connection $exactonline -Table Accounts -Columns ("Name","CreditLinePurchase") -Values ($_.Name, $_.CreditLinePurchase) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ExactOnline -Connection $exactonline -Table Accounts -Columns ("Name","CreditLinePurchase") -Values ($_.Name, $_.CreditLinePurchase)
  }
}

おわりに

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