SQLAlchemy ORM を使用して Python で Sage Intacct のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Sage Intacct と SQLAlchemy ツールキットを使用して、Sage Intacct に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Sage Intacct のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Sage Intacct のデータ を操作する際に比類のないパフォーマンスを提供します。Sage Intacct に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Sage Intacct にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

はじめに

---

Sage Intacct のデータ への接続

Sage Intacct のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

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 およびパスワード（独自のWeb サービスクレデンシャルを使用している場合のみ）。

独自のWeb サービスクレデンシャルではなく、埋め込みクレデンシャルを使用する場合は、以下を実行する必要があります：

• Web サービスダッシュボードで、会社 -> 会社情報 -> セキュリティタブに移動します。
• Web サービス認証に"CData" を追加します。これは大文字・小文字が区別されます。これを行うには、会社 -> 会社情報（新しいUI では、設定 -> 会社）-> セキュリティ -> Web サービス認証 / 編集に移動します。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Sage Intacct にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Sage Intacct のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Sage Intacct のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

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

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、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、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

Sage Intacct のデータ の挿入

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

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

Sage Intacct のデータ の更新

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 のデータ の削除

Sage Intacct のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for Sage Intacct の30日間の無料トライアルをダウンロードして、Sage Intacct のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。