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

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

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

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

Xero WorkflowMax への接続を設定

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

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

    Import-Module XeroWorkflowMaxCmdlets;

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

    $conn = Connect-XeroWorkflowMax  -APIKey "$APIKey" -AccountKey "$AccountKey"

WorkflowMax API に接続するには、Xero からAPIKey とAccountKey を取得します。取得については、 Xero のサポートにお問い合わせ頂く必要があります。(https://www.workflowmax.com/contact-us).

API キーとAccount キーを取得したら、APIKey とAccountKey 接続プロパティの値を設定してください。 これらが設定されれば、接続の準備は完了です。

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

Xero WorkflowMax データを取得してCSV にパイプライン

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

Select-XeroWorkflowMax -Connection $conn -Table Clients | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myClientsData.csv -NoTypeInformation

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

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

データの削除

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

Select-XeroWorkflowMax -Connection $conn -Table Clients -Where "Name = Cynthia" | Remove-XeroWorkflowMax

データの挿入と更新

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

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

おわりに

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