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

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

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

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

SmartHR への接続を設定

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

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

    Import-Module APICmdlets;

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

    $conn = Connect-SmartHR  -Profile "$Profile" -UseSandbox "$UseSandbox" -ProfileSettings "$ProfileSettings" -TenantId "$TenantId" -'' "$''"

SmartHR に接続するには、SmartHR API トークンとTenantId が必要です。API トークンはSmartHR のアプリケーション統合ページで生成できます。トークンを取得したら、ProfileSettings API Key 接続プロパティに指定してください。TenantId は自身のSmartHR ページのURL「https://1234567890.smarthr.jp/」で確認できます（ここでは「1234567890」）。もしSandbox 環境を使用する場合は、接続プロパティにUseSandbox=true を設定してください。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

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

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

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

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

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

おわりに

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