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

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

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

CData のコネクタを使えば、freee API にリアルタイムで直接接続して、ODI 上で通常のデータベースと同じようにfreee のデータを操作できます。freee エンティティのデータモデルを構築、マッピングを作成し、データの読み込み方法を選択するだけの簡単なステップでfreee のデータの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 の機能を使ってモデルをリバースエンジニアリングすることで、ドライバー側で取得したfreee のデータのリレーショナルビューに関するメタデータが取得できます。リバースエンジニアリング後、リアルタイムfreee のデータにクエリを実行してfreee テーブルのマッピングを作成できます。

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

     まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

     次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

     その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

     • AuthScheme：OAuth に設定します。
     • OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
     • OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
     • CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
     • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

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

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

     java -jar cdata.jdbc.api.jar

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

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

     jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
4. Physical Schema 画面で、以下の情報を入力します。
   • Name：ドロップダウンメニューから選択します。
   • Database (Catalog)：CData と入力します。
   • Owner (Schema)：freee にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はAPI と入力します。
   • Database (Work Catalog)：CData と入力します。
   • Owner (Work Schema)：freee にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はAPI と入力します。
5. 開いたモデルで「Reverse Engineer」をクリックしてfreee テーブルのメタデータを取得します。

freee のデータの編集と保存

リバースエンジニアリング後、ODI でfreee のデータを操作できるようになります。 freee のデータを表示するには、Designer ナビゲーターでモデルアコーディオンを展開し、テーブルを右クリックして「View data」をクリックします。

ETL プロジェクトの作成

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

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

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

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

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