SQLAlchemy ORM を使って、Python でSAP SuccessFactors のデータに連携する方法

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

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SAPSuccessFactors は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで SAP SuccessFactors にデータ連携するPython アプリケーションを構築し、SAP SuccessFactors のデータを可視化できます。 本記事では、SQLAlchemy でSAP SuccessFactors に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. SAP SuccessFactors をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSAP SuccessFactors のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSAP SuccessFactors の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSAP SuccessFactors のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、SAP SuccessFactors のデータに連携するEngne を作成します。

engine = create_engine("sapsuccessfactors///?User=username&Password=password&CompanyId=CompanyId&Url=https://api4.successfactors.com")

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 のデータのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、ExtAddressInfo テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class ExtAddressInfo(base):
	__tablename__ = "ExtAddressInfo"
	address1 = Column(String,primary_key=True)
	zipCode = Column(String)
	...

SAP SuccessFactors のデータをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("sapsuccessfactors///?User=username&Password=password&CompanyId=CompanyId&Url=https://api4.successfactors.com")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(ExtAddressInfo).filter_by(city="Springfield"):
	print("address1: ", instance.address1)
	print("zipCode: ", instance.zipCode)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

ExtAddressInfo_table = ExtAddressInfo.metadata.tables["ExtAddressInfo"]
for instance in session.execute(ExtAddressInfo_table.select().where(ExtAddressInfo_table.c.city == "Springfield")):
	print("address1: ", instance.address1)
	print("zipCode: ", instance.zipCode)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

SAP SuccessFactors のデータの挿入（INSERT）

SAP SuccessFactors のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、SAP SuccessFactors にすべての追加インスタンスを送ります。

new_rec = ExtAddressInfo(address1="placeholder", city="Springfield")
session.add(new_rec)
session.commit()

SAP SuccessFactors のデータを更新（UPDATE）

SAP SuccessFactors のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、SAP SuccessFactors にレコードを追加します。

updated_rec = session.query(ExtAddressInfo).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.city = "Springfield"
session.commit()

SAP SuccessFactors のデータを削除（DELETE）

SAP SuccessFactors のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(ExtAddressInfo).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

SAP SuccessFactors からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。