Connect to Jira Service Management Data from PowerBuilder via JDBC

The CData JDBC driver for Jira Service Management 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 Jira Service Management in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Jira Service Management to perform reads and writes.

Connect to Jira Service Management Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Jira Service Management. 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.jiraservicedesk.JiraServiceDeskDriver
   • URL: Enter the JDBC URL.

     You can establish a connection to any Jira Service Desk Cloud account or Server instance.

     Connecting with a Cloud Account

     To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

     Supply the following to connect to data:

     • User: Set this to the username of the authenticating user.
     • APIToken: Set this to the API token found previously.

     Connecting with a Service Account

     To authenticate with a service account, supply the following connection properties:

     • User: Set this to the username of the authenticating user.
     • Password: Set this to the password of the authenticating user.
     • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

     Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

     Accessing Custom Fields

     By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Jira Service Management JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.jiraservicedesk.jar
     

     Fill in the connection properties and copy the connection string to the clipboard. A typical JDBC URL is below:

     jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;

   👁 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 Jira Service Management 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 Jira Service Management 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.jiraservicedesk.JiraServiceDeskDriver',URL='jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;";
CONNECT USING SQLCA;
dw_requests.SetTransObject(SQLCA);
dw_requests.Retrieve();