Ready to get started?

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

Download Now

Enable the Confluence JDBC Driver in KNIME

Use standard data access components in KNIME to create charts and reports with Confluence data.

One of the strengths of the CData JDBC Driver for Confluence is its cross-platform support, enabling integration with major BI tools. Follow the procedure below to access Confluence data in KNIME and to create a chart from Confluence data using the report designer.

Define a New JDBC Connection to Confluence Data

  1. Install the Report Designer extension: Click File -> Install KNIME Extensions, and filter on "Report".
  2. In a new workflow, click File -> Preferences and expand the KNIME -> Databases node to add cdata.jdbc.confluence.jar. The driver JAR is located in the lib subfolder of the installation directory.
  3. In the Node Repository view, expand the Database -> Read/Write node and drag a Database Reader onto the workflow editor.
  4. Double-click the Database Reader and set the following properties:

    • Database Driver: In the menu, select the driver name, cdata.jdbc.confluence.ConfluenceDriver
    • Database URL: Enter the connection properties. The JDBC URL begins 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.

      A typical JDBC URL is below.

      jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
    • User Name: The username used to authenticate.
    • Password: The password used to authenticate.
    • SQL Statement: Enter an SQL query in the SQL Statement box or double-click a table. This article uses the query below to create a chart: SELECT Key, Name FROM Pages WHERE Id = '10000'
  5. Test the connection by clicking Fetch Metadata.

  6. Connect the Database Reader to a Data to Report node to supply the dataset to a range of data visualization controls. Click Execute and then click Edit Report at the top of the workflow to open the report designer perspective.
  7. You can now generate reports based on live data. To create a chart, drag the chart control from the palette to the report designer. In the resulting wizard, you can use the filtering and aggregation controls available in KNIME.

Troubleshooting

The following list shows how to resolve common errors:

  • Encountered duplicate row Id "Row1": To resolve this error, add the following to the knime.ini file located in your KNIME installation directory:-Dknime.database.fetchsize=0