【ノーコード】SpagoBI でfreee請求書 に連携する方法

古川えりか
古川えりか
コンテンツスペシャリスト
複雑なSpagoBI × freee請求書 データ連携をノーコードで。JDBCの設定からレポート配信まで手順を詳しく解説。データ分析・レポーティング環境をすぐに構築できます。

CData JDBC Driver for API はJDBC 標準をサポートするビジネスインテリジェンスおよびデータマイニングツールからリアルタイムfreee請求書 に接続することを可能にします。この記事では、freee請求書 をSpagoBI Studio のレポートに統合し、SpagoBI サーバーでホストする方法を説明します。

SpagoBI サーバーのJDBC ドライバーをデプロイ

以下のステップに従ってSpagoBI サーバーでJDBC data source for API を作成します。

  1. ドライバーJAR を%CATALINA_BASE%/lib にコピーします。これらのファイルは、インストールディレクトリのlib サブフォルダにあります。

  2. freee請求書 ドライバーリソースをコンテクストに追加します。以下のリソース定義をserver.xml の［GlobalNamingResources］要素に追加できます。 

    
<Resource name="jdbc/api" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

  3. 以下のリソースリンクを追加し、Web アプリケーションへのアクセスを許可します。この記事では、SpagoBI のMETA-INF\context.xml に次の行を追加します。 
    
<ResourceLink global="jdbc/api" name="jdbc/api" type="javax.sql.DataSource"/>
  4. サーバーを再起動します。

SpagoBI サーバーのリソースにドライバーを追加した後、データソースを追加します。SpagoBIで［Resources］->［Data Source］->［Add］と進み、以下の情報を入力します。

  • Label:ドライバーに独特の識別子を入力します。
  • Description:ドライバーにディスクリプションを入力します。
  • Dialect:デフォルトの方言を選択します。
  • Read Only:読み取り専用オプションを選択します。このオプションは、データソースがエンドユーザーによって作成された、データセットを保存するためのデフォルトデータベースであるかどうかを決定します。
  • Type:［JDBC］を選択します。
  • 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

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

    Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

    jdbc:api:Profile=freeeinvoice.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  • Driver:ドライバーのクラス名にcdata.jdbc.api.APIDriver を入力します。
The configuration for the freee請求書 JDBC data source.(Salesforce is shown.)

SpagoBI Studio でレポートを作成

以下のステップに従い、SpagoBI Studioでfreee請求書 に基づいたレポートを作成します。SQL クエリの結果をチャートに挿入するデータセットを作成します。次のセクションでは、このレポートをSpagoBI サーバーでホストします。

初めに、SpagoBI Studio のレポートからfreee請求書 に接続してください。

  1. SpagoBI Studio で、［File］->［New］->［Project］とクリックしていき、［Business Intelligence and Reporting Tools］フォルダで［Report Project］を選択します。
  2. ［File］->［New］->［Report］と進み、［Blank Report］を選択します。
  3. ［Data Explorer］ビューで［Data Sources］を右クリックし、［New Data Source］をクリックします。
  4. ［JDBC Data Source］を選択し、データソース名を入力します。
  5. ［Manage Drivers］をクリックし、［Add］をクリックしてドライバーJAR(cdata.jdbc.api.jar) を追加します。
  6. ドライバーJAR　は、インストールディレクトリのlib サブフォルダにあります。
  7. ［Driver Class］メニューでドライバークラス(cdata.jdbc.api.APIDriver)を選択します。
  8. ［Database URL］ボックスに、［JDBC URL］を入力します。以下は一般的な接続文字列です。 
    jdbc:api:Profile=freeeinvoice.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    必要な接続プロパティを取得するためのガイドについては、ドライバーヘルプの［Getting Started］チャプターを見てください。 The JDBC data source.(Salesforce is shown.)

freee請求書 に接続した後、SQL クエリの結果を含むデータセットを作成します。

  1. ［DataSet］フォルダを右クリックし、［New Data Set］をクリックします。JDBC data source for API を選択し、データセットの名称を入力します。
  2. SQL クエリを構築します。ここでは、このクエリを使用してダッシュボードにチャートを追加します。例： 
    SELECT Id, IssueDate FROM Invoices
    The query to be used to populate a chart.(Salesforce is shown.)

データセットを使用して、レポートオブジェクトにデータを入力できます。以下のステップに従って、チャートを作成します。

  1. ［Palette］ビューで、チャートをキャンバスにドラッグします。
  2. ［Select Chart Type］タブで棒グラフを選択します。
  3. ［Select Data］タブで［Use Data From］オプションをクリックし、メニューからfreee請求書 のデータセットを選択します。
  4. Id をテーブルからx 軸の系列にドラッグします。
  5. IssueDate をテーブルからy 軸の系列にドラッグします。 Columns in the dataset defined as the x- and y-axes for the chart.(Salesforce is shown.)

SpagoBI サーバーに関するホストfreee請求書 レポート

以下のステップに従って、SpagoBI サーバーでリアルタイムfreee請求書 に基づいてドキュメントをホストできます。前のセクションで作成したレポートをテンプレートとして使用します。レポートユーザーがリアルタイムデータにアクセスできるようにするには、サーバー上のfreee請求書 JDBC データソースに置き換えられるプレースホルダパラメータを作成します。

  1. 未実行の場合、SpagoBI Studio で［Report Design］パースペクティブで開きます。
  2. ［Data Explorer］ビューで［Report Parameters］フォルダを右クリックし、［New Parameter］をクリックします。url パラメータを追加し、それに空の値を割り当てます。このパラメータはSpagoBI サーバー上のJDBC データソースのプレースホルダです。
  3. freee請求書 のデータソースを右クリックし、［Edit］をクリックします。

  4. ［Property Binding］ノードで、JDBC Driver のURL バインディングプロパティurl パラメータに設定します。プロパティのボックスをクリックします。［Category］セクションで［Report Parameters］を選択します。［Subcategory］セクションで［All］を選択し、パラメータをダブルクリックします。

    JavaScript構文に以下のように入力することもできます。 

    params["url"].value
    Placeholder values in the report for the JDBC data source on the server.

続いて、SpagoBI サーバーでレポート用の新しいドキュメントを作成します。

  1. SpagoBI サーバーで、［Documents Development］->［Create Document］->［Generic Document］と進みます。［Document Details］ページが表示されます。
  2. 以下の情報を入力し、ドキュメントを作成します。
    • Label:ドキュメントに独自の識別子を入力します。
    • Name:ドキュメントのわかりやすい名前を入力します。
    • Type:メニューから［Report］を選択します。
    • Engine:［BIRT Report Engine］を選択します。
    • Data Source:SpagoBI サーバーのCreate a JDBC Data Source for API で作成したfreee請求書 Data Source を選択します。
  3. ［Show Document Templates］セクションで、ドキュメントを格納したいフォルダを選択します。

  4. ［Template］セクションで、［Choose File］をクリックします。レポートプロジェクトを含むフォルダに移動します。.rptdesign ファイルを選択します。

    Noteプロジェクトへのパスは、プロジェクトプロパティで確認できます。

  5. ［Save］ボタンをクリックします。
The document using the report as a template.(Salesforce is shown.)

サーバーでレポートを実行すると、プレースホルダurl パラメータがサーバーで定義されたJDBC URL に置き換えられます。

The chart running on the SpagoBI Server.(Salesforce is shown.)

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

API Driver で freee請求書 のライブデータに接続

freee請求書 に接続

この記事の内容

関連記事