BIRT でConfluence のデータのレポートを作成
CData JDBC Driver for Confluence は、データドリブンな Java アプリケーションにConfluence API への接続機能を統合します。CData JDBC Driver for Confluence を BIRT(Business Intelligence Reporting Tools)プラットフォームと組み合わせることで、データの変更をリアルタイムに反映する BIRT レポートを作成できます。
- まだインストールしていない場合は、BIRT Framework プラグインと Database Development プラグインを Eclipse にインストールします。
- 「File」->「New」->「Report」をクリックします。Report Design パースペクティブが開きます。
- Data Explorer で「Data Sources」を右クリックし、「New Data Source」をクリックします。
- 「Create from a Data Source Type in the Following List」オプションを選択し、「JDBC Data Source」を選択します。
- 「Manage Drivers」をクリックし、インストールフォルダの lib サブフォルダにあるドライバー JAR を追加します。
- 「Database URL」ボックスに、接続文字列を含む 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 インスタンスへの認証を行うには、以下のように指定します。
- AuthScheme:Basic に設定。
- 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 接続プロパティも設定しておくと良いでしょう。返される行数が制限されるため、レポートやビジュアライゼーションの設計時のパフォーマンスが向上します。
一般的な JDBC URL は以下のとおりです:
jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
- 「Data Sets」フォルダを右クリックし、Confluence用の JDBC データソースを選択します。
- 表示されるダイアログで、レポート用のデータを取得する SELECT クエリを作成します。この記事では以下のクエリを使用します:
SELECT Key, Name FROM Pages WHERE Id = '10000'
- 「Palette」からエディターにチャートをドラッグします。チャートウィザードが表示されます。
- チャートタイプを選択した後、「Select Data」タブでカラムをチャートフィールドにドラッグします。
- 「Run」->「View Report」->「In Web Viewer」をクリックしてレポートを表示します。
これで、BIRT レポートがConfluence のデータの更新を反映できるようになりました。
レポートをアプリケーションサーバーに公開するには、ドライバー JAR を BIRT Viewer のクラスパスに追加します。詳細については、Java アプリケーションサーバーへの JDBC ドライバのデプロイに関する CData KB ガイドを参照してください。