Bold BI dashboard designer supports connecting Jira web services through REST API.
To configure the Jira data source, follow the below steps:
Click the Data Sources button in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the Jira connection in the connection panel.
NOTE: You can also create a data source from the home page by clicking the Data Sources menu from left menu panel and Create Data Source from the data sources page.
Once you click the data source, the NEW DATA SOURCE configuration panel opens. Follow the below steps to create Jira data source.
Enter a name and description (optional) for the data source.
Enter a valid Jira REST API in the URL textbox. Refer the Jira API documentation for more details.
Choose a time interval for Refresh Settings using the combo box, to trigger the Rest API request periodically to keep the data in sync with our dashboard.
Select JSON data type in Data Format combo box.
Choose Basic http Authentication under Authentication Type and input a valid Username and API Token.
You can also edit the connection information set here using the Edit Connection option.
Enter your domain name in the Domain URL textbox.
Enter a valid JQL Query in JQL field.
project = weather
If you need to add custom fields in JQL filtering, then enable Include Custom Fields and provide the custom fields in enabled text box.
In Max Rows, enter the maximum number of rows to be fetched from the Jira data source. This value is used to fetch the data from Jira data source via pagination.
In your Jira account, Go to the JQL query search under Filters -> Advanced Search.
Type a Custom field in the JQL search box and you can view the respective Custom field ID in the dropdown as shown in the following image.
You can add the Custom field ID values in the Datasource connection window to retrieve the custom fields data.
The syntax for adding Custom Fields,
customfield_<Custom Field ID>
Here, the Epic Link and Epic Name custom fields are added in the following image.
- The Custom field IDs must be separated by using a comma.
- If you have a Jira Admin account, you can also view the Custom fields ID by the ways mentioned in this link.
To retrieve any field, including custom fields in Jira and pass the field details to the
Include Custom Fields text box, follow these steps:
Example: To fetch the value of the project -> name field, add
project to the Custom Fields.
Split the nested field name using a colon
: to identify the nested fields.
For example: To fetch the ID of the status Category of the status.
- When accessing the inner fields of a nested field in Jira, separate the field names with colons
- For fetching a custom field with a specific field ID, follow the same procedure by specifying the Custom field ID followed by a colon and the field ID. For example:
- Multiple values can be passed as default, nested array, or custom fields in the Include Custom Fields text box, and the values should be separated by commas (,). For example:
- When fetching the inner fields of an array, only the first element of the array will be fetched based on the field’s value.
Enter a valid URL in the URL field textbox.
Select GET method for the REST API in Method combo box.
|Max Rows||Most of the REST APIs return only fewer data on a single API request. To pull the amount of data you need, set a value in this field. Pagination is handled internally and will fetch the amount of data you need.|
|Refresh Settings||Period of time before next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date. If you do not want to sync your new data, choose ‘Never’.|
Replace <:your_domain> with your domain name in the URL.
For instance, to get the tasks/issues under specific project, replace your JQL Query in the textarea.
Sample Domain URL:
project = weather
For more information on the API endpoints available for this data source, refer to their official API Documentation
List tasks based on status modified
project = weather AND status CHANGED FROM “In Progress” TO “Open”
List tasks based on status on specified week
project = weather AND status was “In Progress” DURING (startOfWeek(), endOfWeek())
List tasks based on resolution
project = “weather” AND resolution changed to “Done” by currentUser() during (startOfYear(), endOfYear())
List tasks based on fixVersion
project = weather AND fixVersion = latestReleasedVersion(weather)
Click Preview & Connect to connect with the configurations set.
The Choose Schema(s) dialog opens. The schema represents the key fields of data retrieved from Jira Rest API request. This dialog displays a list of schemas in treeview and its corresponding values in grid for preview. Select required schema(s) from treeview to use in designer and click Connect.
Now, the data design view page with selected table schema opens. Drag and drop the table.
Click Save to save the data source with a relevant name.