FineReport で Confluence のデータ を利用する
CData JDBC Driver for Confluence は、JDBC 標準を完全に実装しており、さまざまなBI、レポート、ETL ツール、カスタムアプリケーションに Confluence のデータ への接続を提供します。この記事では、FineReport で Confluence のデータ をJDBC データソースとして設定し、レポートデザイナーで Confluence のデータ をテーブルとして表示する方法を説明します。
Confluence のデータ のJDBC データソースをセットアップする
以下の手順に従って、FineReport のデータベース接続として Confluence のデータ を設定します。
- CData JDBC Driver for Confluence のインストールディレクトリにあるlib フォルダから、cdata.jdbc.confluence.jar ファイルをFineReport のインストールディレクトリにあるlib フォルダにコピーします。cdata.jdbc.confluence.lic ファイルも同様にコピーしてください。
- ServerタブからDefine Data Connectionを選択し、クリックして新しい接続を追加してJDBCをクリックします。
続いて、ウィンドウでデータ接続の定義を設定します。
- Database: Others
- JDBC Driver: cdata.jdbc.confluence.ConfluenceDriver
-
URL: セミコロン区切りの接続プロパティを使用した標準のJDBC 接続文字列を入力します。
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; - Connection pool attributesをクリックし、Test before getting connectionsをNoに設定します。
Test connectionをクリックして、接続が正しく設定されていることを確認します。これで、Confluence への接続を設定し、FineReport のデータソースとして使用できるようになります。
レポートデザイナーで Confluence のデータ を選択する
- クリックして新しいテンプレートデータセットを追加し、DB queryを選択してデータベースクエリウィンドウを開きます。
- ドロップダウンリストから、作成したJDBC 接続を選択します。
- 左ペインにConfluence のエンティティがテーブルとして表示されます。
- ロードするConfluence のデータ のテーブルとカラムに対してSELECT 文を記述します。
- プレビューをクリックすると、データがテーブルとして表示されます。
このように簡単な手順で、FineReport で Confluence をJDBC データソースとして利用できるようになります。