Jaspersoft Studio から ApprovalMax のデータに接続

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Jaspersoft Studio でApprovalMax のデータにSQL を実行。



この記事では、CData JDBC Driver for ApprovalMax を使って、Jaspersoft Studio からApprovalMax に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってApprovalMax へのSQL クエリを作成していきます。クエリは直接ApprovalMax API に実行されるため、ApprovalMax のデータへのリアルタイム接続が可能になります。

ApprovalMax のデータにJDBC データソースとして接続

Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。

  1. Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
  2. Database JDBC Connection を選択します。
  3. ドライバーのわかりやすい名前を入力します。
  4. Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
  5. Database Location タブで、JDBC ドライバーのクラス名を入力します：cdata.jdbc.api.APIDriver
  6. 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 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。

    以下はApprovalMax の一般的な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;
    JDBC Driver を使用するように構成されたデータアダプタ（図はSalesforce）

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

以下のステップに従って、ApprovalMax へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。

  1. File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
  2. Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
  3. Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例： 
    
SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'
    レポートにデータを取り込むためのSQL クエリ（図はSalesforce）
  4. データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
  5. Group By ステップをスキップして、ウィザードを完了します。

Preview タブで、現在のApprovalMax のデータでレポートがどのように表示されるかをプレビューできます。

リアルタイムデータが入力されたJasperReport テンプレート（図はSalesforce）

チャートを作成

以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。

DataSet を作成

以下のステップに従って、チャートを入力する新しいデータセットを作成します。

  1. レポートの編集エリアで、Design タブをクリックします。
  2. Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
  3. データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
  4. Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
  5. 次のようなクエリを入力します： 
    
SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'
    チャートを入力するためのSQL クエリ（図はSalesforce）
  6. データセットに含めるフィールドを選択します。この例ではUserId とEmail を使用します。
  7. フィールドによるグループ化のステップをスキップして、ウィザードを完了します。

チャートを構成

データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。

  1. Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
  2. パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
  3. チャートのタイプを選択します。この例では棒グラフを使用します。
  4. Dataset メニューで、チャート用に作成したデータセットを選択します。
  5. Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
  6. チャートのシリーズを指定します：Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、UserId カラムをダブルクリックして、式を$F{UserId} に設定します。 チャートのシリーズとして選択されたカラム

  7. y 軸の値を指定します：チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、Email をダブルクリックして、式を$F{Email} に設定します。

  8. シリーズ要素のラベルを指定します：チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、UserId カラムをダブルクリックして、式を$F{UserId} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します： 
    
$F{UserId}.toString()
    チャートの軸に選択されたカラム
  9. チャートを拡大してSummary セクションを埋めます：チャートを右クリックして、Size to Container -> Fit Both をクリックします。

レポートの実行

他のJDBC データソースと同様に、ApprovalMax のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。

完成したレポートの最終ページ（チャートを表示）（図はSalesforce）

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

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

ApprovalMax に接続

この記事の内容

関連記事