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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でEpicor Kinetic のデータをモデル化

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

engine = create_engine("epicorkinetic///?Service=Erp.BO.CustomerSvc&ERPInstance=MyInstance&URL=https://myaccount.epicorsaas.com&User=username&Password=password&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

ERP インスタンスに接続するには、次の接続プロパティを指定してください。

• Url：ERP インスタンスをホストしているサーバーのURL。例えば、https://myserver.EpicorSaaS.com
• ERPInstance：ERP インスタンス名。
• User：アカウントのユーザー名。
• Password：アカウントのパスワード。
• Service：データを取得するサービス。例えば、BaqSvc。

また、オプションで次の接続プロパティを指定することもできます。

• ApiKey：アカウント設定に応じて、いくつかのサービスへの接続に必要となるオプションのキー。
• ApiVersion：デフォルトはv1。新しいEpicor API を使用するにはv2 に設定してください。
• Company：ApiVersion をv2 に設定した場合は必須になります。

Epicor Kinetic のデータのマッピングクラスの宣言

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

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	CustNum = Column(String,primary_key=True)
	Company = Column(String)
	...

Epicor Kinetic のデータをクエリ

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

query メソッドを使う

engine = create_engine("epicorkinetic///?Service=Erp.BO.CustomerSvc&ERPInstance=MyInstance&URL=https://myaccount.epicorsaas.com&User=username&Password=password&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(CompanyName="CompanyName"):
	print("CustNum: ", instance.CustNum)
	print("Company: ", instance.Company)
	print("---------")

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

execute メソッドを使う

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.CompanyName == "CompanyName")):
	print("CustNum: ", instance.CustNum)
	print("Company: ", instance.Company)
	print("---------")

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

Epicor Kinetic のデータの挿入（INSERT）

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

new_rec = Customers(CustNum="placeholder", CompanyName="CompanyName")
session.add(new_rec)
session.commit()

Epicor Kinetic のデータを更新（UPDATE）

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

updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CompanyName = "CompanyName"
session.commit()

Epicor Kinetic のデータを削除（DELETE）

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

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

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

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

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