JayDeBeApi を使って Python からSuiteCRM のデータにアクセス

Python と Java がインストールされている環境であれば、Python スクリプトと標準 SQL を使ってSuiteCRM のデータにアクセスできます。CData JDBC Driver for SuiteCRM と JayDeBeApi モジュールを組み合わせることで、Python からリモートのSuiteCRM のデータを操作できます。CData ドライバーを使用することで、業界標準に準拠した実績のあるドライバーを Python という人気の高い言語で活用できます。この記事では、ドライバーを使って SuiteCRM に SQL クエリを実行し、標準的な Python でSuiteCRM のデータを可視化する方法を説明します。

JayDeBeApi モジュールを使用

JayDeBeApi は、JDBC（Java Database Connectivity）のブリッジとして機能する Python ライブラリで、Python プログラムから CData JDBC ドライバーを含む Java データベースとやり取りできるようになります。pip install コマンドでモジュールをインストールします。

pip install JayDeBeApi

JDBC URL を作成

JayDeBeApi をインストールしたら、SQL を使って Python からSuiteCRM のデータを操作する準備が整います。

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

• Schema：suitecrmv4 に設定。
• Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
• User：SuiteCRM に紐づいているユーザーに設定。
• Password：SuiteCRM に紐づいているパスワードに設定。

SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

ビルトイン接続文字列デザイナー

JDBC URL の作成には、SuiteCRM JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。

java -jar cdata.jdbc.suitecrm.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、一般的な JDBC 接続文字列を含む変数の例です。

jdbc_url = "jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"

Python からSuiteCRM のデータにアクセス

JDBC URL を設定したら、あとは JDBC ドライバーの JAR ファイルへの絶対パスだけが必要です。これはインストールディレクトリの "lib" フォルダにあります（Windows では "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.suitecrm.jar"）。

注意: まだ設定していない場合は、JAVA_HOME 環境変数を Java のインストールディレクトリに設定してください。

以下のようなコードで SuiteCRM からデータを読み取り、表示できます。

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.suitecrm.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.suitecrm.SuiteCRMDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Accounts;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

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

CData JDBC Driver for SuiteCRM の 30 日間無料トライアルをダウンロードして、Python でリアルタイムのSuiteCRM のデータを操作してみてください。ご不明な点がございましたら、サポートチームまでお問い合わせください。