Python でSAP SuccessFactors のデータを変換・出力するETL 処理を作る方法

Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for SAPSuccessFactors とpetl フレームワークを使って、SAP SuccessFactors のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

CData Python Connector は効率的なデータ処理によりSAP SuccessFactors のデータ にPython から接続し、高いパフォーマンスを発揮します。SAP SuccessFactors にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接SAP SuccessFactors 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。

必要なモジュールのインストール

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でSAP SuccessFactors のデータをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.sapsuccessfactors as mod

接続文字列で接続を確立します。connect 関数を使って、CData SAP SuccessFactors Connector からSAP SuccessFactors への接続を行います

cnxn = mod.connect("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;")

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 をクエリするSQL 文の作成

SAP SuccessFactors にはSQL でデータアクセスが可能です。ExtAddressInfo エンティティからのデータを読み出します。

sql = "SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'"

SAP SuccessFactors データのETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、SAP SuccessFactors のデータ を取得して、zipCode カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'zipCode')

etl.tocsv(table2,'extaddressinfo_data.csv')

CData Python Connector for SAPSuccessFactors を使えば、データベースを扱う場合と同感覚で、SAP SuccessFactors のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

SAP SuccessFactors Python Connector の30日の無償トライアル をぜひダウンロードして、SAP SuccessFactors のデータ への接続をPython アプリやスクリプトから簡単に作成しましょう。

フルソースコード

import petl as etl
import pandas as pd
import cdata.sapsuccessfactors as mod

cnxn = mod.connect("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;")

sql = "SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'zipCode')

etl.tocsv(table2,'extaddressinfo_data.csv')