BambooHR のデータをPowerShell でMySQL にレプリケーションする方法

古川えりか
古川えりか
コンテンツスペシャリスト
PowerShell のシンプルなスクリプトで、BambooHR のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。

CData Cmdlets for API を使えば、PowerShell からBambooHR のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for API およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。

まずは、PowerShell でBambooHR への接続を行います。レプリケーションは4つのステップがあります。

まず、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 KeyDomain の両方を設定して接続します。

BambooHR のデータの取得

  1. モジュールのインストール:

    Install-Module APICmdlets
  2. BambooHR への接続:

      $api = Connect-API  -Profile $Profile -ProfileSettings $ProfileSettings -APIKey $APIKey
      
  3. 取得ターゲットのリソースの取得:

      $data = Select-API -Connection $api -Table "Employees"
      

    Invoke-API cmdlet を使って、SQL-92 クエリを使用することもできます:

      $data = Invoke-API -Connection $api -Query 'SELECT * FROM Employees WHERE Department = @Department' -Params @{'@Department'='Sales'}
      
  4. 戻り値からカラム名のリストを保存します。

      $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
      

BambooHR のデータをMySQL データベースにレプリケーション

カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。

  1. モジュールのインストール:

    Install-Module MySQLCmdlets
  2. MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:

      $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
      
  3. BambooHR、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、BambooHR のリソース(Employees)と同じテーブル名を持っている必要があります。

      $data | % {
        $row = $_
        $values = @()
        $columns | % {
          $col = $_
          $values += $row.$($col)
        }
        Add-MySQL -Connection $mysql -Table "Employees" -Columns $columns -Values $values
      }
      

次回以降のレプリケーションをシンプルに実現

  • 一度PowerShell でBambooHR とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:

      Select-API -Connection $api -Table "Employees" | % {
        $row = $_
        $values = @()
        $columns | % {
          $col = $_
          $values += $row.$($col)
        }
        Add-MySQL -Connection $mysql -Table "Employees" -Columns $columns -Values $values
      }
      
  • 別のPowerShell モジュールで、BambooHR を別のデータベースに複製する場合、Select-API cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

      $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
      

おわりに

これで、BambooHR のデータをMySQL に複製できました。分析、BI などでBambooHR のデータをMySQL から使うことができるようになります。

はじめる準備はできましたか?

API Driver で BambooHR のライブデータに接続

BambooHR に接続 お問い合わせ