Integrate Confluence Data in the Pentaho Report Designer

The CData JDBC Driver for Confluence data enables access to live data from dashboards and reports. This article shows how to connect to Confluence data as a JDBC data source and publish reports based on Confluence data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Confluence connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:confluence: and is followed by a semicolon-separated list of connection properties.

     Obtaining an API Token

     An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

     Connect Using a Confluence Cloud Account

     To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

     • User: The user which will be used to authenticate with the Confluence server.
     • APIToken: The API Token associated with the currently authenticated user.
     • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

     Connect Using a Confluence Server Instance

     To connect to a Server instance, provide the following:

     • User: The user which will be used to authenticate with the Confluence instance.
     • Password: The password which will be used to authenticate with the Confluence server.
     • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Confluence JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.confluence.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     Below is a typical JDBC URL:

     jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
   • Custom Driver Class Name: Enter cdata.jdbc.confluence.ConfluenceDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add Confluence Data to a Report

You are now ready to create a report with Confluence data.

1. Add the Confluence source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT Key, Name FROM Pages WHERE Id = '10000'
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Pages table.
4. Finally, run the report to see the chart.