PowerShell からSAP SuccessFactors のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

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

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

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

SAP SuccessFactors への接続を設定

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

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

    Import-Module SAPSuccessFactorsCmdlets;

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

    $conn = Connect-SAPSuccessFactors  -User "$User" -Password "$Password" -CompanyId "$CompanyId" -Url "$Url"

Basic 認証またはOAuth with SAML アサーションを使用して、SAP SuccessFactors に認証できます。

Basic 認証

SAP SuccessFactors に正常に認証するには、次のプロパティの値を指定する必要があります。プロバイダーは、Cookie を使用してSAP SuccessFactors によって開かれたセッションを再利用することに注意してください。つまり、セッションを開く最初のリクエストでのみクレデンシャルが使用されます。その後、SAP SuccessFactors から返されたCookie が認証に使用されます。

• Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
• User: アカウントのユーザー名に設定。
• Password: アカウントのパスワードに設定。
• CompanyId: 会社の一意の識別子に設定。

OAuth 認証

アクセストークンを取得するために使用される、次のプロパティの値を指定する必要があります。

• Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
• User: アカウントのユーザー名に設定。
• CompanyId: 会社の一意の識別子に設定。
• OAuthClientId: API Center で生成されたAPI Key に設定。
• OAuthClientSecret: SAML アサーションの署名に使用されるX.509 プライベートキー。プライベートキーは、「Registering your OAuth Client Application」でダウンロードした証明書に記載されています。
• InitiateOAuth: GETANDREFRESH に設定。

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

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

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

Select-SAPSuccessFactors -Connection $conn -Table ExtAddressInfo | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myExtAddressInfoData.csv -NoTypeInformation

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

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-SAPSuccessFactors -Connection $conn -Table ExtAddressInfo -Where "city = Springfield" | Remove-SAPSuccessFactors

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyExtAddressInfoUpdates.csv | %{
  $record = Select-SAPSuccessFactors -Connection $SAPSuccessFactors -Table ExtAddressInfo -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SAPSuccessFactors -Connection $sapsuccessfactors -Table ExtAddressInfo -Columns ("address1","zipCode") -Values ($_.address1, $_.zipCode) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-SAPSuccessFactors -Connection $sapsuccessfactors -Table ExtAddressInfo -Columns ("address1","zipCode") -Values ($_.address1, $_.zipCode)
  }
}

おわりに

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