Ready to get started?

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

Download Now

Connect to Confluence Data in CloverDX (formerly CloverETL)

Transfer Confluence data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Confluence enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Confluence as sources. In this article, you will use the JDBC Driver for Confluence to set up a simple transfer into a flat file. The CData JDBC Driver for Confluence enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Confluence as sources. In this article, you will use the JDBC Driver for Confluence to set up a simple transfer into a flat file.

Connect to Confluence as a JDBC Data Source

  1. Create the connection to Confluence data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.confluence.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

    jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

Query Confluence Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Confluence JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Key, Name FROM Pages WHERE Id = '10000'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Pages table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.