SQLAlchemy ORM を使って、Python でBullhorn CRM データに連携

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムBullhorn CRM data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Bullhorn CRM に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Bullhorn CRM 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Bullhorn CRM Data への接続

Bullhorn CRM data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Begin by providing your Bullhorn CRM account credentials in the following:

• DataCenterCode: Set this to the data center code which responds to your data center. Refer to the list of data-center-specific Bullhorn API URLs: https://bullhorn.github.io/Data-Center-URLs/

If you are uncertain about your data center code, codes like CLS2, CLS21, etc. are cluster IDs that are contained in a user's browser URL (address bar) once they are logged in.

Example: https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... indicates that the logged in user is on CLS21.

Authenticating with OAuth

Bullhorn CRM uses the OAuth 2.0 authentication standard. To authenticate using OAuth, create and configure a custom OAuth app. See the Help documentation for more information.

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからBullhorn CRM に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBullhorn CRM Data をモデル化します

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

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

Bullhorn CRM Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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="Jane Doe"):
	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 == "Jane Doe")):
	print("Id: ", instance.Id)
	print("CandidateName: ", instance.CandidateName)
	print("---------")

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

Bullhorn CRM Data の挿入（INSERT）

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

new_rec = Candidate(Id="placeholder", CandidateName="Jane Doe")
session.add(new_rec)
session.commit()

Bullhorn CRM Data を更新（UPDATE）

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

updated_rec = session.query(Candidate).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CandidateName = "Jane Doe"
session.commit()

Bullhorn CRM Data を削除（DELETE）

Bullhorn CRM data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、Bullhorn CRM data への接続をPython アプリやスクリプトから簡単に作成しましょう。