Apache Airflow でBullhorn CRM データに連携したワークフローを作る

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Apache Airflow を使うと、データエンジニアリングワークフローの作成、スケジューリング、および監視を行うことができます。CData JDBC Driver for BullhornCRM と組み合わせることで、Airflow からリアルタイムBullhorn CRM データに連携できます。 この記事では、Apache Airflow インスタンスからBullhorn CRM データに接続してクエリを実行し、結果をCSV ファイルに保存する方法を紹介します。

最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムBullhorn CRM データを扱う上で高いパフォーマンスを提供します。 Bullhorn CRM にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのBullhorn CRM 側でサポートしているSQL 操作をBullhorn CRM に直接渡し、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってBullhorn CRM データを操作および分析できます。

Bullhorn CRM への接続を構成する

組み込みの接続文字列デザイナー

JDBC URL の作成の補助として、Bullhorn CRM JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

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

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」セクションを参照してください。

クラスタ環境またはクラウドでJDBC ドライバーをホストするには、ライセンス（フルまたはトライアル）およびランタイムキー（RTK）が必要です。本ライセンス（またはトライアル）の取得については、こちらからお問い合わせください。

以下は、JDBC 接続で要求される必須プロパティです。

Airflow でJDBC 接続を確立する

1. Apache Airflow インスタンスにログインします。
2. Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。
3. 次の画面で「+」マークをクリックして新しい接続を作成します。
4. Add Connection フォームで、必要な接続プロパティを入力します。
   • Connection Id：接続の名前：bullhorncrm_jdbc
   • Connection Type：JDBC Connection
   • Connection URL：上記のJDBC 接続URL：jdbc:bullhorncrm:RTK=5246...;DataCenterCode=CLS33;OAuthClientId=myoauthclientid;OAuthClientSecret=myoauthclientsecret;InitiateOAuth=GETANDREFRESH
   • Driver Class：cdata.jdbc.bullhorncrm.BullhornCRMDriver
   • Driver Path：PATH/TO/cdata.jdbc.bullhorncrm.jar
5. フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
6. 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。

DAG を作成する

Airflow におけるDAG は、ワークフローのプロセスを格納するエンティティであり、DAG にトリガーを設定することでワークフローを実行することができます。 今回のワークフローでは、シンプルにBullhorn CRM データに対してSQL クエリを実行し、結果をCSV ファイルに格納します。

1. はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
2. 次に新しいPython ファイルを作成し、タイトルをbullhorn crm_hook.py にします。この新規ファイル内に、次のコードを挿入します。

   		import time
   		from datetime import datetime
   		from airflow.decorators import dag, task
   		from airflow.providers.jdbc.hooks.jdbc import JdbcHook
   		import pandas as pd
   
   		# Dag の宣言
   		@dag(dag_id="bullhorn crm_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv'])
   	
   		# Dag となる関数を定義（取得するテーブルは必要に応じて変更してください）
   		def extract_and_load():
   		# Define tasks
   			@task()
   			def jdbc_extract():
   				try:
   					hook = JdbcHook(jdbc_conn_id="jdbc")
   					sql = """ select * from Account """
   					df = hook.get_pandas_df(sql)
   					df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1)
   					# print(df.head())
   					print(df)
   					tbl_dict = df.to_dict('dict')
   					return tbl_dict
   				except Exception as e:
   					print("Data extract error: " + str(e))
               
   			jdbc_extract()
       
   		sf_extract_and_load = extract_and_load()
   	

3. このファイルを保存し、Airflow インスタンスをリフレッシュします。DAG リストの中に、「bullhorn crm_hook」というタイトルの新しいDAG が表示されるはずです。
4. このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー（＝play）ボタンをクリックしてDAG を実行します。この操作で、bullhorn crm_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。
5. 新規のDAG を実行後、Downloads フォルダ（またはPython スクリプト内で選択したフォルダ）を確認し、CSV ファイルが作成されていることを確認します（本ワークフローの場合はaccount.csv です）。
6. CSV ファイルを開くと、Apache Airflow によってBullhorn CRM データがCSV 形式で利用できるようになったことが確認できます。

詳細と無償トライアル