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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSage Intacct のデータをモデル化

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

engine = create_engine("sageintacct///?User=myusername&CompanyId=TestCompany&Password=mypassword&SenderId=Test&SenderPassword=abcde123")

Sage Intacct 接続プロパティの取得・設定方法

独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

Sage Intacct への認証

Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

Basic 認証

Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

• AuthScheme：Basic。
• CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
• User：Sage Intacct へのログインに使用するログイン名。
• Password：ログインクレデンシャル用のパスワード。
• （オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード。

Sage Intacct のデータのマッピングクラスの宣言

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

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

Sage Intacct のデータをクエリ

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

query メソッドを使う

engine = create_engine("sageintacct///?User=myusername&CompanyId=TestCompany&Password=mypassword&SenderId=Test&SenderPassword=abcde123")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customer).filter_by(CustomerId="12345"):
	print("Name: ", instance.Name)
	print("TotalDue: ", instance.TotalDue)
	print("---------")

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

execute メソッドを使う

Customer_table = Customer.metadata.tables["Customer"]
for instance in session.execute(Customer_table.select().where(Customer_table.c.CustomerId == "12345")):
	print("Name: ", instance.Name)
	print("TotalDue: ", instance.TotalDue)
	print("---------")

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

Sage Intacct のデータの挿入（INSERT）

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

new_rec = Customer(Name="placeholder", CustomerId="12345")
session.add(new_rec)
session.commit()

Sage Intacct のデータを更新（UPDATE）

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

updated_rec = session.query(Customer).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CustomerId = "12345"
session.commit()

Sage Intacct のデータを削除（DELETE）

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

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

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

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

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