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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBullhorn CRM のデータをモデル化

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

engine = create_engine("bullhorncrm///?DataCenterCode=CLS33&OAuthClientId=myoauthclientid&OAuthClientSecret=myoauthclientsecret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Bullhorn CRM 接続プロパティの取得・設定方法

Bullhorn CRM に接続するには、Bullhorn CRM アカウントの資格情報を入力します。また、DataCenterCode プロパティをデータセンターに対応するデータセンターコードに設定してください。詳しくは、こちら を参照してください。

CLS2、CLS21 などのコードはクラスタID で、ログインした際のブラウザのURL（アドレスバー）に含まれます。

例えば、

こちらのURL は、ログインしたユーザーがCLS21 クラスタに存在することを示しています。

ちなみに、コールバックURL の末尾に"/" を含む値、例えば http://localhost:33333/ を指定する場合は、アプリケーション設定で指定したコールバックURL と厳密に同じ値を指定する必要があります。このパラメータの文字が一致しない場合、エラーとなります。

Bullhorn CRM への認証（OAuth）

Bullhorn CRM ではOAuth 2.0 認証標準を利用できます。 OAuth を使用して認証するには、すべてのシナリオでカスタムOAuth アプリケーションを作成して設定する必要があります。詳しい認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

Bullhorn CRM のデータのマッピングクラスの宣言

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

base = declarative_base()
class Candidate(base):
	__tablename__ = "Candidate"
	Id = Column(String,primary_key=True)
	CandidateName = Column(String)
	...

Bullhorn CRM のデータをクエリ

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

query メソッドを使う

engine = create_engine("bullhorncrm///?DataCenterCode=CLS33&OAuthClientId=myoauthclientid&OAuthClientSecret=myoauthclientsecret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Candidate).filter_by(CandidateName="山田太郎"):
	print("Id: ", instance.Id)
	print("CandidateName: ", instance.CandidateName)
	print("---------")

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

execute メソッドを使う

Candidate_table = Candidate.metadata.tables["Candidate"]
for instance in session.execute(Candidate_table.select().where(Candidate_table.c.CandidateName == "山田太郎")):
	print("Id: ", instance.Id)
	print("CandidateName: ", instance.CandidateName)
	print("---------")

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

Bullhorn CRM のデータの挿入（INSERT）

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

new_rec = Candidate(Id="placeholder", CandidateName="山田太郎")
session.add(new_rec)
session.commit()

Bullhorn CRM のデータを更新（UPDATE）

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

updated_rec = session.query(Candidate).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CandidateName = "山田太郎"
session.commit()

Bullhorn CRM のデータを削除（DELETE）

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

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

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

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

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