PowerShell からClio のデータに接続してデータの取得・CSV エクスポートを実行する方法
CData Cmdlets for API を使えば、PowerShell からClio に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Clio への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Clio への接続を設定
それでは、まずはClio への接続設定からはじめていきましょう。接続設定にはCData Clio Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module APICmdlets;
Connect-API コマンドを使ってClio との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-API -Profile "$Profile" -ProfileSettings "$ProfileSettings" -Authscheme "$Authscheme" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackUrl "$CallbackUrl"
まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。
Clio API プロファイル設定
Clio はOAuth ベースの認証を使用します。
まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
- CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
- Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。
これで接続設定は完了です。
Clio のデータを取得してCSV にパイプライン
接続が完了したので、Bills テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-API -Connection $conn -Table Bills | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myBillsData.csv -NoTypeInformation
このコードでは、Select-API から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
おわりに
このように、CData Cmdlets を使えばPowerShell でのClio のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。