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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSAP Ariba Source データをモデル化

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

engine = create_engine("saparibasource///?API=SupplierDataAPIWithPagination-V4&APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU&Environment=SANDBOX&Realm=testRealm&AuthScheme=OAuthClient&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

SAP Ariba Source に接続するには、以下を設定します。

• API：本製品にSAP Ariba データを取得させたいAPI を指定。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）。
• DataCenter：アカウントのデータがホストされているデータセンター。
• Realm：アクセスしたいサイト名。
• Environment：テスト環境、または本番環境のいずれかに指定。（可能な値は、TEST またはPRODUCTION）。

Supplier Data API またはContract API に接続する場合は、さらに以下を設定します。

• User：API 呼び出しを行うユーザーのId。
• PasswordAdapter：認証するUser に関連付けられたパスワード。

Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定します。

OAuth 認証

接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。

• AuthScheme をOAuthClient に設定します。
• サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。

  OAuth アプリケーションの作成について、詳しくはヘルプドキュメントを参照してください。

OAuth の自動リフレッシュ

以下を設定して、接続してください。

• APIKey：アプリケーション設定のApplication key。
• OAuthClientId：アプリケーション設定のOAuth Client Id。
• OAuthClientSecret：アプリケーション設定のOAuth Secret。

接続すると、本製品は自動でOAuth プロセスを完了します。

1. 本製品はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
2. 本製品はアクセストークンの期限が切れると自動的にリフレッシュします。
3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます。

SAP Ariba Source データのマッピングクラスの宣言

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

base = declarative_base()
class Vendors(base):
	__tablename__ = "Vendors"
	SMVendorID = Column(String,primary_key=True)
	Category = Column(String)
	...

SAP Ariba Source データをクエリ

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

query メソッドを使う

engine = create_engine("saparibasource///?API=SupplierDataAPIWithPagination-V4&APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU&Environment=SANDBOX&Realm=testRealm&AuthScheme=OAuthClient&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Vendors).filter_by(Region="USA"):
	print("SMVendorID: ", instance.SMVendorID)
	print("Category: ", instance.Category)
	print("---------")

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

execute メソッドを使う

Vendors_table = Vendors.metadata.tables["Vendors"]
for instance in session.execute(Vendors_table.select().where(Vendors_table.c.Region == "USA")):
	print("SMVendorID: ", instance.SMVendorID)
	print("Category: ", instance.Category)
	print("---------")

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

SAP Ariba Source データの挿入（INSERT）

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

new_rec = Vendors(SMVendorID="placeholder", Region="USA")
session.add(new_rec)
session.commit()

SAP Ariba Source データを更新（UPDATE）

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

updated_rec = session.query(Vendors).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Region = "USA"
session.commit()

SAP Ariba Source データを削除（DELETE）

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

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

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

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

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