Oracle Data Integrator で Freee Invoice データをETL

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Oracle Data Integrator を使用してFreee Invoice のデータをデータウェアハウスに転送する方法を説明します。

JDBC 標準を使用して、既存のスキルを活かしながらFreee Invoice に接続できます。 Oracle Data Integrator(ODI)などの ETL ツールにドロップインで統合できる CData JDBC Driver for Freee Invoice を使えば、リアルタイムのFreee Invoice のデータをデータウェアハウス、ビジネスインテリジェンス、ビッグデータテクノロジーに接続できます。

JDBC 接続により、ODI でFreee Invoice を他のデータベースと同様に扱うことができます。RDBMS と同じように、フラットファイルではなくリアルタイムでFreee Invoice API に直接接続できます。

この記事では、JDBC ベースの ETL(Freee Invoice から Oracle へ)の手順を説明します。Freee Invoice エンティティのデータモデルをリバースエンジニアリングした後、マッピングを作成し、データロード戦略を選択します。ドライバーが SQL-92 をサポートしているため、組み込みの SQL to SQL Loading Knowledge Module を選択するだけで簡単に実現できます。

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

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

  • UNIX/Linux(エージェントなし): ~/.odi/oracledi/userlib
  • UNIX/Linux(エージェントあり): ~/.odi/oracledi/userlib および $ODI_HOME/odi/agent/lib
  • Windows(エージェントなし): %APPDATA%\Roaming\odi\oracledi\userlib
  • Windows(エージェントあり): %APPDATA%\odi\oracledi\userlib および %APPDATA%\odi\agent\lib

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

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

モデルをリバースエンジニアリングすると、ドライバーのFreee Invoice のデータに対するリレーショナルビューのメタデータが取得されます。リバースエンジニアリング後は、リアルタイムのFreee Invoice のデータをクエリし、Freee Invoice テーブルに基づいてマッピングを作成できます。

  1. ODI でリポジトリに接続し、New -> Model and Topology Objects をクリックします。
  2. 表示されるダイアログの Model 画面で、以下の情報を入力します。
    • Name: API と入力します。
    • Technology: Generic SQL を選択します(ODI バージョン 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 Invoice JDBC Driver に組み込まれている接続文字列デザイナーをご利用ください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

      java -jar cdata.jdbc.api.jar
      

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

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

      jdbc:api:Profile=freeeinvoice.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 Invoice でスキーマを選択した場合は選択したスキーマを入力し、それ以外の場合は API と入力します。
    • Database (Work Catalog): CData と入力します。
    • Owner (Work Schema): Freee Invoice でスキーマを選択した場合は選択したスキーマを入力し、それ以外の場合は API と入力します。
  5. 開いたモデルで Reverse Engineer をクリックして、Freee Invoice テーブルのメタデータを取得します。

Freee Invoice のデータの編集と保存

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

ETL プロジェクトの作成

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

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

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

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

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

はじめる準備はできましたか?

API Driver で Freee Invoice のライブデータに接続

Freee Invoice に接続