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

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
Jaspersoft Studio でConfluence のデータにSQL を実行。

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

Confluence のデータに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.confluence.ConfluenceDriver
  6. JDBC URL を入力します。

    Confluence 接続プロパティの取得・設定方法

    任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

    Confluence への認証

    Confluence は、次の認証メソッドをサポートしています:API トークン、Basic 認証、OAuth 2.0、SSO。

    API トークン - Confluence Cloud アカウント

    トークンの取得

    アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

    トークンを使用する認証

    Cloud アカウントへの認証を行うには、以下を入力します。

    • AuthScheme:APIToken に設定。
    • User:Confluence サーバーに認証する際に使用されるユーザー。
    • APIToken:現在認証されているユーザーに紐づくAPI トークン。
    • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

    Basic 認証 - Confluence Server インスタンス

    Server インスタンスへの認証を行うには、以下のように指定します。

    • AuthSchemeBasic に設定。
    • User:Confluence インスタンスに認証する際に使用されるユーザー。
    • Password:Confluence サーバーに認証する際に使われるパスワード。
    • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
    その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

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

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

    java -jar cdata.jdbc.confluence.jar
    

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

    JDBC URL を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。

    以下はConfluence の一般的なJDBC URL です:

    jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
    

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

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

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

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

チャートを作成

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

DataSet を作成

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

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

チャートを構成

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

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

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

レポートの実行

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

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

Confluence Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Confluence Icon Confluence JDBC Driver お問い合わせ

Confluence に連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。