Oracle Data Integrator でZendesk のデータをETL する方法

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

Oracle Data Integrator（ODI）はOracle エコシステムのハイパフォーマンスなデータ統合プラットフォームです。CData JDBC Driver for Zendesk を使えば、OCI をはじめとするETL ツールからZendesk のデータにJDBC 経由で簡単に読み取りと書き込みを実現できます。リアルタイムZendesk のデータをデータウェアハウス、BI・帳票ツール、CRM、基幹システムなどに統合すれば、データ活用もぐっと楽に。

CData のコネクタを使えば、Zendesk API にリアルタイムで直接接続して、ODI 上で通常のデータベースと同じようにZendesk のデータを操作できます。Zendesk エンティティのデータモデルを構築、マッピングを作成し、データの読み込み方法を選択するだけの簡単なステップでZendesk のデータのETL が実現できます。

ドライバーのインストール

ドライバーをインストールするには、インストールフォルダにあるドライバーのJAR ファイルと.lic ファイルをODI の適切なディレクトリにコピーします。

• UNIX/Linux（Agent なし）：~/.odi/oracledi/userlib
• UNIX/Linux（Agent）：$ODI_HOME/odi/agent/lib
• Windows（Agent なし）：%APPDATA%\Roaming\odi\oracledi\userlib
• Windows（Agent）：%APPDATA%\Roaming\odi\agent\lib

ODI を再起動してインストールを完了します。

モデルのリバースエンジニアリング

ODI の機能を使ってモデルをリバースエンジニアリングすることで、ドライバー側で取得したZendesk のデータのリレーショナルビューに関するメタデータが取得できます。リバースエンジニアリング後、リアルタイムZendesk のデータにクエリを実行してZendesk テーブルのマッピングを作成できます。

1. ODI でリポジトリに接続し、「New」->「Model and Topology Objects」をクリックします。
2. 表示されるダイアログの「Model」画面で、以下の情報を入力します。
   • Name：Zendesk と入力します。
   • Technology：Technology:Generic SQL（ODI がVersion 12.2+ の場合はMicrosoft SQL Server）を選択します。
   • Logical Schema：Zendesk と入力します。
   • Context：Global を選択します。
   
3. 表示されるダイアログの「Data Server」画面で、以下の情報を入力します。
   • Name：Zendesk と入力します。
   • Driver List：Oracle JDBC Driver を選択します。
   • Driver：cdata.jdbc.zendesk.ZendeskDriver と入力します。
   • URL：接続文字列を含むJDBC URL を入力します。

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

     Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

     また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

     Zendesk への認証

     Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

     API トークン認証

     API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

     1. Token アクセスを有効にします。
     2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
     最後に、APIToken をアクティブなAPI トークンに設定します。

     その他の認証方法についてはヘルプドキュメントを参照してください。

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

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

     java -jar cdata.jdbc.zendesk.jar

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

     

     一般的な接続文字列は次のとおりです。

     jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
   
4. Physical Schema 画面で、以下の情報を入力します。
   • Name：ドロップダウンメニューから選択します。
   • Database (Catalog)：CData と入力します。
   • Owner (Schema)：Zendesk にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はZendesk と入力します。
   • Database (Work Catalog)：CData と入力します。
   • Owner (Work Schema)：Zendesk にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はZendesk と入力します。
   
5. 開いたモデルで「Reverse Engineer」をクリックしてZendesk テーブルのメタデータを取得します。

Zendesk のデータの編集と保存

リバースエンジニアリング後、ODI でZendesk のデータを操作できるようになります。 Zendesk のデータを編集し保存するには、Designer ナビゲーターでモデルアコーディオンを展開し、テーブルを右クリックして「Data」をクリックします。「Refresh」をクリックしてデータの変更を取得します。変更が完了したら「Save Changes」をクリックします。

ETL プロジェクトの作成

次の手順に従って、Zendesk からETL を作成します。Tickets エンティティをODI Getting Started VM に含まれているサンプルデータウェアハウスにロードします。

1. SQL Developer を開き、Oracle データベースに接続します。Connections ぺインでデータベースのノードを右クリックし、「New SQL Worksheet」をクリックします。

   もしくは、SQLPlus を使用することもできます。コマンドプロンプトから、以下のように入力します。

   sqlplus / as sysdba
2. 以下のクエリを入力し、ODI_DEMO スキーマにあるサンプルデータウェアハウスに新しいターゲットテーブルを作成します。以下のクエリは、Zendesk のTickets テーブルに一致するいくつかのカラムを定義します。 CREATE TABLE ODI_DEMO.TRG_TICKETS (SUBJECT NUMBER(20,0),Id VARCHAR2(255));
3. ODI でDesigner ナビゲーターのModels アコーディオンを展開し、ODI_DEMO フォルダの「Sales Administration」ノードをダブルクリックします。Model Editor でモデルが開きます。
4. 「Reverse Engineer」をクリックします。TRG_TICKETS テーブルがモデルに追加されます。
5. プロジェクトの「Mappings」ノードを右クリックし、「New Mapping」をクリックします。マッピングの名前を入力し、「Create Empty Dataset」オプションを無効にします。Mapping Editor が表示されます。
6. TRG_TICKETS テーブルをSales Administration モデルからマッピングにドラッグします。
7. Tickets テーブルをZendesk モデルからマッピングにドラッグします。
8. ソースコネクタポイントをクリックしてターゲットコネクタポイントにドラッグします。Attribute Matching ダイアログが表示されます。ここでは、デフォルトオプションを使用します。その場合、目的の動作はターゲットカラムのプロパティに表示されます。
9. Mapping Editor のPhysical タブを開き、TARGET_GROUP の「TICKETS_AP」をクリックします。
10. TICKETS_AP プロパティで、Loading Knowledge Module タブの「LKM SQL to SQL (Built-In)」を選択します。

これで、マッピングを実行してZendesk のデータをOracle にロードできます。