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

CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSAP Fieldglass にOR マッピング可能に。

加藤龍彦
デジタルマーケティング

最終更新日:2023-09-23

この記事で実現できるSAP Fieldglass 連携のシナリオ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("sapfieldglass///?EnvironmentURL='https://myinstance.com'&Username=myuser&Password=mypassword&APIKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

資格情報の取得

SAP Fieldglass の担当者に問い合わせ、OAuthClientIdOAuthClientSecretEnvironmentURL を入手してください。

SAP Fieldglass への接続

運用環境への認証を行うには、以下のように指定します。

  • APIKey:SAP Fieldglass API キー。これはオプションですが、API キーが必要であることを示すSAP Fieldglass からのエラーが発生した場合は、SAP Fieldglass 管理者に依頼するか、SAP Fieldglass Integration Tools にログインしてCreate API Application をクリックします。
  • OAuthClientId:SAP Fieldglass 担当者から取得したOAuth Client ID。
  • OAuthClientSecret:SAP Fieldglass 担当者から取得したOAuth Client Secret。
  • EnvironmentURL:SAP Fieldglass 担当者から取得したSAP Fieldglass Environment URL。

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

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

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

SAP Fieldglass のデータをクエリ

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

query メソッドを使う

engine = create_engine("sapfieldglass///?EnvironmentURL='https://myinstance.com'&Username=myuser&Password=mypassword&APIKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AuditTrails).filter_by(Company="CData"):
	print("Id: ", instance.Id)
	print("Category: ", instance.Category)
	print("---------")

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

execute メソッドを使う

AuditTrails_table = AuditTrails.metadata.tables["AuditTrails"]
for instance in session.execute(AuditTrails_table.select().where(AuditTrails_table.c.Company == "CData")):
	print("Id: ", instance.Id)
	print("Category: ", instance.Category)
	print("---------")

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。