Connect to Confluence Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Confluence, HULFT Integrate can work with live Confluence data. This article walks through connecting to Confluence and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Confluence data. When you issue complex SQL queries 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). Its built-in dynamic metadata querying allows you to work with and analyze Confluence data using native data types.

Enable Access to Confluence

To enable access to Confluence data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.confluence.jar (and cdata.jdbc.confluence.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Confluence Data

Once you copy the JAR files, you can create a project with access to Confluence data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: ConfluencetoCSV)

Once you create the project, add components to the script to copy Confluence data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Confluence. Set the following properties:
   • Name: Confluence Connection Settings
   • Driver class name: cdata.jdbc.confluence.ConfluenceDriver
   • URL: jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.
2. Write your SQL statement. For example:

   SELECT Key, Name FROM Pages

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. Pages.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map Confluence Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Confluence data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Confluence and start working with your live Confluence data in HULFT Integrate. Reach out to our Support Team if you have any questions.