PowerShell からBambooHR のデータに接続してデータの取得・CSV エクスポートを実行する方法

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

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

BambooHR への接続を設定

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

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

    Import-Module APICmdlets;

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

    $conn = Connect-API  -Profile "$Profile" -ProfileSettings "$ProfileSettings" -APIKey "$APIKey"

まず、Profile 接続プロパティをディスク上のBambooHR プロファイルの場所に設定します（例：C:\profiles\bamboohr.apip）。次に、ProfileSettings 接続プロパティをBambooHR の接続文字列に設定します（以下を参照）。

BambooHR API プロファイル設定

BambooHR に認証するには、API キーを提供する必要があります。API キーを生成するには、ログインして任意のページの右上隅にある自分の名前をクリックし、ユーザーコンテキストメニューにアクセスします。十分な権限がある場合、そのメニューに「API Keys」オプションが表示され、新しいAPI キーを作成できるページに移動できます。また、BambooHR アカウントのドメイン名にあるDomain を設定します。例えば、BambooHR アカウントがacmeinc.bamboohr.com の場合、Domain は「acmeinc」となります。ProfileSettings プロパティにAPI Key とDomain の両方を設定して接続します。

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

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

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

Select-API -Connection $conn -Table Employees | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myEmployeesData.csv -NoTypeInformation

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

おわりに

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