Pentaho Report Designer でApprovalMax のデータを連携利用

CData JDBC Driver for ApprovalMax のデータ を使えば、ダッシュボードやレポートからリアルタイムデータにアクセスできます。この記事では、ApprovalMax のデータにJDBC データソースとして接続し、Pentaho でApprovalMax のデータをもとにしたレポートを公開する方法を説明します。

接続してレポートを作成

1. インストールディレクトリのlib サブフォルダ内にあるドライバーのJAR ファイルを、Pentaho ディレクトリ内の\Report-Designer\lib\jdbc\ フォルダにコピーします。
2. \Report-Designer\ フォルダ内のreport-designer.bat ファイルを実行してReport-Designer UI を開きます。

3. Data -> Add Data Source -> Advanced -> JDBC（Custom）をクリックし、新しいApprovalMax 接続を作成して、ドライバーで新しいデータソースを作成します。 表示されるダイアログで、以下のように接続プロパティを設定します。

   • Custom Connection URL property：JDBC URL を入力します。JDBC URL はjdbc:api: で始まり、その後にセミコロン区切りで接続プロパティを指定します。

     まず、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 を設定する際、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;

   • Custom Driver Class Name：cdata.jdbc.api.APIDriver を入力します。
   • User Name：認証に使用するユーザー名。
   • Password：認証に使用するパスワード。
   

レポートにApprovalMax のデータを追加

ApprovalMax のデータをもとにレポートを作成する準備が整いました。

1. レポートにApprovalMax のソースを追加します。Data -> Add Data Source -> JDBC をクリックしてデータソースを選択します。

2. クエリを設定します。この記事では以下のクエリを使用します：

   SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'

   
3. レポートにチャートをドラッグし、ダブルクリックしてチャートを編集します。レポートを実行してチャートを表示します。このクエリの結果を使用して、UserProfiles テーブルのシンプルなチャートを作成できます。
4. 最後に、レポートを実行してチャートを確認します。