Ready to get started?

Learn more about the CData JDBC Driver for Confluence or download a free trial:

Download Now

Build Visualizations of Confluence Data in Birst

Use the CData JDBC Driver for Confluence and the Birst Cloud Agent to build real-time visualizations of Confluence data in Birst.

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for Confluence, you can connect to live Confluence data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to Confluence using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live Confluence data operations in Birst. When you issue complex SQL queries from Birst to Confluence, the driver pushes supported SQL operations, like filters and aggregations, directly to Confluence and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze Confluence data using native Birst data types.

Configure a JDBC Connection to Confluence Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

  1. Create a new project in Birst.
  2. Name the connection (e.g. CDataConfluence).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. Set SQL Type to MSSQL
  7. Set the Connection string.

    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 connection string for Confluence:

    jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
  8. Set the Driver Name: cdata.jdbc.confluence.ConfluenceDriver and click Save.

NOTE: Since authentication to Confluence is managed from the connection string, you can leave Security Credentials blank.

Configure Confluence Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

  1. Select the Schema (e.g. Confluence).
  2. Click on Tables and/or Views to connect to those entities and click Apply.
  3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

  1. Select the Visualizer tool from the menu.
  2. Select Measures & Categories from your objects
  3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for Confluence with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Confluence data. Download a free, 30-day trial and start building Birst visualizations today.