Query Jira Service Management Data in ColdFusion

The CData JDBC driver for Jira Service Management seamlessly integrates connectivity to Jira Service Management data with the rapid development tools in ColdFusion. This article shows how to connect to Jira Service Management data in ColdFusion and query Jira Service Management tables.

Create a JDBC Data Source for Jira Service Management in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:jiraservicedesk: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

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

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Jira Service Management data source in the Actions column. After reporting a status of OK, the Jira Service Management data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Jira Service Management, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="JiraServiceDeskQuery" dataSource="CDataJiraServiceDesk">
 SELECT * FROM Requests WHERE CurrentStatus = <cfqueryparam value="#CurrentStatus#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#JiraServiceDeskQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM Requests WHERE CurrentStatus = ?", 
 [
 { value="Open", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataJiraServiceDesk" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?CurrentStatus=Open