freee JDBC ドライバーを使用したOBIEE でのfreee レポート

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

CData JDBC Driver for API は、freee へのリアルタイムアクセスをJava ベースのレポートサーバーに統合できる標準のデータベースドライバーです。この記事では、ドライバーをOracle Business Intelligence Enterprise Edition (OBIEE) にデプロイし、変更を反映するfreee に関する方法を示します。

JDBC ドライバーをデプロイ

以下のステップに従って、WebLogic のクラスパスにJDBC ドライバーを追加します。

WebLogic 12.2.1 の場合、ドライバーJAR と.lic ファイルをORACLE_HOME\user_projects\domains\MY_DOMAIN\lib のようにDOMAIN_HOME\lib に配置します。これらのファイルは、起動時にサーバーのクラスパスに追加されます。

ドライバーをクラスパスに手動で追加することもできます。これは、以前のバージョンで必要です。setDomainEnv.cmd (Windows) または setDomainEnv.sh (Unix) のPRE_CLASSPATH の前に以下を追加します。このスクリプトは、そのドメインのフォルダーのbin サブフォルダーにあります。例：ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

DOMAIN_HOME\bitools\bin でstop コマンドとstart コマンドを実行するなど、すべてのサーバーを再起動します。

JDBC Data Source for API の作成

JDBC ドライバーをデプロイした後、BI Publisher からJDBC データソースを作成できます。

1. BI Publisher にURL http://localhost:9502/analytics でログインし、［Administration］->［Manage BI Publisher］とクリックします。
2. ［JDBC Connection］->［Add Data Source］と進みます。
3. 以下の情報を入力します。
   • Data Source Name:ユーザーが接続を作成する名前をレポートに入力します。
   • Driver Type:SELECTOther.
   • Database DriverClass:ドライバークラスに cdata.jdbc.api.APIDriver を入力します。
   • Connection String: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 URL を構成する際に、Max Rows プロパティを定めることも可能です。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

     以下は一般的なJDBC URL です。

     jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
   • Username:ユーザー名。
   • Password:パスワード。
4. ［Security］セクションで、許可されているユーザーロールを選択します。

リアルタイムのfreee レポートを作成

リアルタイムのfreee に基づいてレポートと分析を作成できるようになります。以下のステップに従って、標準のレポートウィザードを使用してfreee への変更を反映するインタラクティブなレポートを作成します。

1. グローバルヘッダーで、［New］->［Data Model］をクリックします。
2. Diagram タブでメニューからSQL クエリを選択します。
3. クエリの名前を入力し、［Data Source］メニューで、作成したfreee JDBC データを選択します。
4. 標準のSQL を選択し、以下のようなクエリを入力します。 SELECT Amount, IssueDate FROM Deals
5. ［View Data］をクリックし、レポートの作成に使用するサンプルデータを生成します。
6. サンプルデータに含める行数を選択し、［View］をクリックして［Save As Sample Data］をクリックします。
7. ［Create Report］->［Use Data Model］とクリックします。
8. ［Guide Me］を選択し、［Select Layout］ページで含めるレポートオブジェクトを選択します。この例では、［Chart］と［Table］を選択します。
9. IssueDate のような数値列をy 軸の［Drop Value Here］ボックスにドロップします。Amount のようなディメンション列をx 軸の［Drop Label Here］ボックスにドロップします。
10. ［Refresh］をクリックしてfreee への変更を取得します。