SQLAlchemy ORM を使って、Python でDynamics 365 Business Central のデータに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でDynamics 365 Business Central のデータをモデル化

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

engine = create_engine("d365businesscentral///?OrganizationUrl=https://myaccount.financials.dynamics.com/")

Dynamics 365 Business Central 接続プロパティの取得・設定方法

Dynamics 365 Business Central への認証には、User およびAccessKey プロパティが必要です。

データに接続するには、OrganizationUrl を指定します。OrganizationUrl は、 http：//businesscentral.dynamics.com/abc123/ などのBusiness Central アカウントへのエンドポインであるか、Web サービスのルートを参照する必要があります。OrganizationUrl を指定する方法 および利用可能なエンドポイントについての詳細は、Business Central エンドポイント を参照してください。組織内に複数の会社がある場合は、どの会社に接続するかを特定するためにCompany を指定する必要があります。 会社が1つだけの場合は、Company を指定する必要はありません。

Dynamics 365 Business Central に認証するには、User およびAccessKey 接続プロパティを指定します。Microsoft では、これらをテストおよび開発目的で推奨します。ただし、運用環境での使用は推奨していません。User およびAccessKey の値を取得するには、Dynamics 365 Business Central の「ユーザー」ページに移動して「編集」をクリックします。User Name および Web Service Access Key の値は、User およびPassword 接続文字列プロパティとして入力する値です。User Name はE メールアドレス ではありません。短縮されたユーザー名です。

Microsoft では、OAuth 認証を使用する本番ユースケースを推奨します。詳細については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

Dynamics 365 Business Central のデータのマッピングクラスの宣言

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

base = declarative_base()
class Accounts(base):
	__tablename__ = "Accounts"
	accountid = Column(String,primary_key=True)
	Name = Column(String)
	...

Dynamics 365 Business Central のデータをクエリ

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

query メソッドを使う

engine = create_engine("d365businesscentral///?OrganizationUrl=https://myaccount.financials.dynamics.com/")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(Name="MyAccount"):
	print("accountid: ", instance.accountid)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.Name == "MyAccount")):
	print("accountid: ", instance.accountid)
	print("Name: ", instance.Name)
	print("---------")

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

Dynamics 365 Business Central のデータの挿入（INSERT）

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

new_rec = Accounts(accountid="placeholder", Name="MyAccount")
session.add(new_rec)
session.commit()

Dynamics 365 Business Central のデータを更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "MyAccount"
session.commit()

Dynamics 365 Business Central のデータを削除（DELETE）

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

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

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

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

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