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

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

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

SAP SuccessFactorsへの接続

それでは、SAP SuccessFactors に接続していきましょう。CData 製品は、デフォルトで有効になっているOData API を介してSAP SuccessFactors と通信します。追加の権限が必要な場合は、SAP サポートサイトをご確認ください。

認証方法として、Azure AD 認証、SAP IAS 認証、OAuth 認証（推奨）、Basic 認証（非推奨）のいずれかを使用してSAP SuccessFactors に認証できます。

必要な接続プロパティ

選択したAuthScheme に関わらず、SAP SuccessFactors 環境を識別するために以下の接続プロパティを設定しましょう。

• URL：SuccessFactors をホストするサーバーのURL
• CompanyId：SAP SuccessFactors テナントに割り当てられた一意の識別子。この値はAPI 認証に必要で、組織固有のものです

OAuth 認証

SAP SuccessFactors では、OAuth 認証を2種類のグラント種別でサポートしています。

• SAP SuccessFactors LMS インスタンスのクライアントグラント種別
• SAML-2 Bearer グラント種別

OAuth 認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、適切なプロパティを設定する必要があります。

デスクトップアプリケーションでカスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ

以下のプロパティを設定してください。

• InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します
• OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId
• CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI
• OAuthClientSecret （クライアントグラント種別のみ）：アプリケーションの登録時に割り当てられたクライアントシークレット
• PrivateKey （SAML-2 Bearer グラント種別のみ）：カスタムOAuth アプリケーションの作成時にダウンロードした秘密鍵証明書のパス、またはその証明書のbase64 でエンコードされた内容

接続すると、CData 製品がデフォルトブラウザでSAP SuccessFactors のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

アプリケーションにアクセス許可を与えると、CData 製品がOAuth プロセスを完了します。

1. CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
2. OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます

アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。

カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

SAP SuccessFactors のデータの取得

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

   Install-Module SAPSuccessFactorsCmdlets

2. SAP SuccessFactors への接続:

     $sapsuccessfactors = Connect-SAPSuccessFactors  -User $User -Password $Password -CompanyId $CompanyId -Url $Url
     

3. 取得ターゲットのリソースの取得:

     $data = Select-SAPSuccessFactors -Connection $sapsuccessfactors -Table "ExtAddressInfo"
     

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

     $data = Invoke-SAPSuccessFactors -Connection $sapsuccessfactors -Query 'SELECT * FROM ExtAddressInfo WHERE city = @city' -Params @{'@city'='Springfield'}
     

4. 戻り値からカラム名のリストを保存します。

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

SAP SuccessFactors のデータを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. SAP SuccessFactors、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、SAP SuccessFactors のリソース（ExtAddressInfo）と同じテーブル名を持っている必要があります。

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

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

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

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

• 別のPowerShell モジュールで、SAP SuccessFactors を別のデータベースに複製する場合、Select-SAPSuccessFactors cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

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

おわりに

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