We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Build a Simple VCL Application for Jira Service Management Data
How to build a simple VCL Application to view Jira Service Management data in RAD Studio using the CData ODBC Driver for Jira Service Management.
Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Jira Service Management, you gain access to live Jira Service Management data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve and update Jira Service Management data. This article will walk through connecting to Jira Service Management and creating a simple VCL application with the Form Designer.
Create a Connection to Jira Service Management Data
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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, you will need to 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.
You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Jira Service Management data.
- In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
- Right-click the ODBC Data Source node in the Data Explorer.
- Click Add New Connection.
- Enter a name for the connection.
- In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Jira Service Management.
Create VCL Applications with Connectivity to Jira Service Management Data
Follow the procedure below to start executing queries to Jira Service Management data from a simple VCL application that displays the results of a query in a grid.
-
Drop a TFDConnection component onto the form and set the following properties:
- ConnectionDefName: Select the FireDAC connection to Jira Service Management data.
- Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
-
Drop a TFDQuery component onto the form and set the properties below:
- Connection: Set this property to the TFDConnection component, if this component is not already specified.
SQL: Click the button in the SQL property and enter a query. For example:
SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
- Active: Set this property to true.
Drop a TDataSource component onto the form and set the following property:
- DataSet: In the menu for this property, select the name of the TFDQuery component.
-
Drop a TDBGrid control onto the form and set the following property:
- DataSource: Select the name of the TDataSource.
- Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.
You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.
Related Articles
Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.