BIRT でApprovalMax のデータのレポートを作成

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
組み込み分析にApprovalMaxのリアルタイムデータを提供。

CData JDBC Driver for ApprovalMax は、データドリブンな Java アプリケーションにApprovalMax API への接続機能を統合します。CData JDBC Driver for ApprovalMax を BIRT(Business Intelligence Reporting Tools)プラットフォームと組み合わせることで、データの変更をリアルタイムに反映する BIRT レポートを作成できます。

  1. まだインストールしていない場合は、BIRT Framework プラグインと Database Development プラグインを Eclipse にインストールします。
  2. 「File」->「New」->「Report」をクリックします。Report Design パースペクティブが開きます。
  3. Data Explorer で「Data Sources」を右クリックし、「New Data Source」をクリックします。
  4. 「Create from a Data Source Type in the Following List」オプションを選択し、「JDBC Data Source」を選択します。
  5. 「Manage Drivers」をクリックし、インストールフォルダの lib サブフォルダにあるドライバー JAR を追加します。
  6. 「Database URL」ボックスに、接続文字列を含む JDBC URL を入力します。

    まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します(例:C:\profiles\ApprovalMax.apip)。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します(以下を参照)。

    ApprovalMax API プロファイル設定

    ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

    まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal(https://developer.approvalmax.com/applications)にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI(Callback URL)を少なくとも1つ登録しておく必要があります。

    Public API を利用するには、ApprovalMax の Premium サブスクリプション(または有効なトライアル)が必要です。

    以下の接続プロパティを設定すると、接続できるようになります。

    • AuthScheme:OAuth に設定します。
    • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId:ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
    • OAuthClientSecret:ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
    • CallbackURL:アプリケーション設定で登録した Redirect URI に設定します。
    • Scope:(オプション)デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

    OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

    JDBC URL の構築には、ApprovalMax JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

    
    java -jar cdata.jdbc.api.jar
    

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

    組み込みの接続文字列デザイナーを使用して JDBC URL を生成(画像は Salesforce の例)

    JDBC URL を設定する際、Max Rows 接続プロパティも設定しておくと良いでしょう。返される行数が制限されるため、レポートやビジュアライゼーションの設計時のパフォーマンスが向上します。

    一般的な JDBC URL は以下のとおりです:

    
    jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;
    
  7. 「Data Sets」フォルダを右クリックし、ApprovalMax用の JDBC データソースを選択します。
  8. 表示されるダイアログで、レポート用のデータを取得する SELECT クエリを作成します。この記事では以下のクエリを使用します:
    
    SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'
    
  9. 「Palette」からエディターにチャートをドラッグします。チャートウィザードが表示されます。
  10. チャートタイプを選択した後、「Select Data」タブでカラムをチャートフィールドにドラッグします。
  11. 「Run」->「View Report」->「In Web Viewer」をクリックしてレポートを表示します。

これで、BIRT レポートがApprovalMax のデータの更新を反映できるようになりました。 オンデマンドで更新できる BIRT レポート(画像は Salesforce の例)

レポートをアプリケーションサーバーに公開するには、ドライバー JAR を BIRT Viewer のクラスパスに追加します。詳細については、Java アプリケーションサーバーへの JDBC ドライバのデプロイに関する CData KB ガイドを参照してください。

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

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

ApprovalMax に接続