SQLAlchemy ORM を使って、Python でEpicor ERP データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Epicor ERP Python Connector

Epicor ERP へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにEpicor ERP をシームレスに統合。



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

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムEpicor ERP data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Epicor ERP に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Epicor ERP 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Epicor ERP Data への接続

Epicor ERP data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

To successfully connect to your ERP instance, you must specify the following connection properties:

  • Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
  • ERPInstance: the name of your ERP instance.
  • User: the username of your account.
  • Password: the password of your account.
  • Service: the service you want to retrieve data from. For example, BaqSvc.

In addition, you may also set the optional connection properties:

  • ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
  • ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
  • Company: Required if you set the ApiVersion to v2.

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからEpicor ERP に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でEpicor ERP Data をモデル化します

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

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

Epicor ERP Data のマッピングクラスの宣言

接続を確立したら、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 ERP Data をクエリ

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

query メソッドを使う

engine = create_engine("epicorerp///?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 ERP Data の挿入(INSERT)

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

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

Epicor ERP Data を更新(UPDATE)

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

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

Epicor ERP Data を削除(DELETE)

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

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

製品の無償トライアル情報

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