SQLAlchemy ORM を使って、Python でDynamics 365 Business Central データに連携

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

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Dynamics 365 Business Central Python Connector

Dynamics 365 Business Central (NAV) へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにDynamics 365 Business Central (NAV) をシームレスに統合。



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

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

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

Dynamics 365 Business Central Data への接続

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

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 認証の使用」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でDynamics 365 Business Central Data をモデル化します

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

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

Dynamics 365 Business Central Data のマッピングクラスの宣言

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

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入(INSERT)

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

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

Dynamics 365 Business Central Data を更新(UPDATE)

Dynamics 365 Business Central data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 Data を削除(DELETE)

Dynamics 365 Business Central data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、Dynamics 365 Business Central data への接続をPython アプリやスクリプトから簡単に作成しましょう。