Connect to Confluence Data from PowerBuilder via JDBC

The CData JDBC driver for Confluence is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Confluence in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Confluence to retrieve data.

Connect to Confluence Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Confluence. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.confluence.ConfluenceDriver
   • URL: 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;

   👁 The JDBC data source defined in the Database Profile Setup dialog. (Salesforce is shown.)
   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Confluence Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Confluence data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.confluence.ConfluenceDriver',URL='jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;";
CONNECT USING SQLCA;
dw_pages.SetTransObject(SQLCA);
dw_pages.Retrieve();