PyCharm でCData ODBC Driver を使ってSage X3 Cloud に接続

CData ODBC Drivers は、ODBC ドライバーをサポートするあらゆる環境から利用可能です。本記事では、PyCharm からのCData ODBC Driver for SageX3Cloud の利用を説明します。CData ODBC Deriver をデータソースとして設定する方法、データソースをクエリして結果を表示するためのPyCharm の簡単なコードを含みます。

はじめに、このチュートリアルではCData ODBC Driver for SageX3Cloud とPyCharm が、既にインストールされていることを前提としています。

Pyodbc をプロジェクトに追加

以下のステップに従って、pyodbc モジュールをプロジェクトに追加します。

1. ［File］->［Settings］とクリックして［project settings］ウィンドウを開きます。
2. ［Project: YourProjectName］メニューから［Project Interpreter］をクリックします。
3. pyodbc を追加するため、+ ボタンをクリックしてpyodbc と入力します。
4. ［Install Package］をクリックしてpyodbc をインストールします。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Sage X3 Cloud をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにSage X3 Cloud のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてSage X3 Cloud の接続を設定、2.PyCharm 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとSage X3 Cloud への接続設定

まずは、本記事右側のサイドバーからSageX3Cloud ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

これで、ODBC 接続文字列またはDSN で接続できます。お客様のOS でDSN を作成するためのガイドについては、CData ドライバードキュメントの［はじめに］セクションを参照してください。

Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

• URL：Sage X3 Cloud インスタンスのベース URL。
• OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
• OAuthClientId：OAuth アプリケーションのクライアント ID。
• OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
• Audience：トークンリクエストで使用する API の Audience 値。
• XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
• Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
• Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

以下はDSN の構文です。

[CData SageX3Cloud Source]
Driver = CData ODBC Driver for SageX3Cloud
Description = My Description
AuthScheme = OAuth
URL = https://x3server/
OAuthAccessTokenUrl = https://auth-domain/oauth/token
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
Audience = https://api-audience
XAPIKey = your_api_key
Folder = SEED

Sage X3 Cloud へのクエリの実行

Cursor をインスタンス化し、Cursor クラスのexecute メソッドを使用してSQL ステートメントを実行します。

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for SageX3Cloud};AuthScheme = OAuth;URL = https://x3server/;OAuthAccessTokenUrl = https://auth-domain/oauth/token;OAuthClientId = your_client_id;OAuthClientSecret = your_client_secret;Audience = https://api-audience;XAPIKey = your_api_key;Folder = SEED;')
cursor = cnxn.cursor()
cursor.execute("SELECT BPCNUM, BPCNAM FROM BPCUSTOMER WHERE BPCNUM = 'MARTIN'")
rows = cursor.fetchall()
for row in rows:
  print(row.BPCNUM, row.BPCNAM)

CData ODBC Driver を使用してPyCharm でSage X3 Cloud に接続すると、Sage X3 Cloud にアクセスできるPython アプリケーションを標準データベースのように構築できるようになります。このチュートリアルに関する質問、コメント、フィードバックがある場合には、[email protected] までご連絡ください。

Sage X3 Cloud からPyCharm へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

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

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