Overview
This article explains how to add and configure a new datasource for Custom Reports.
On this page: |
Add a Datasource
From Dashboard Hub, click
and select Add Datasource. The datasource selection window displays.Select Custom Report. The Custom Report configuration form displays.
Provide a descriptive name for the datasource.
Enter the URL of the REST API you want to connect to for fetching data (that is, the URL of the product providing the content for your report)
Select an authorization type (see Authentication types in Custom Reports datasources) and enter any required values for that selection. Basic Auth is recommended for this purpose.
Click Add to create the datasource.
Add a Custom Report
From your dashboard, add a Custom Report.
In the configuration window, select Load Template if you already have a saved report. Or create one with the provided content to list issues from a Jira datasource.
Select the datasource added previously. In the provided example, you need to add a Jira datasource and a JQL query Jira in the provided example.
Click Open Editor. The JSON for the fields in the datasource displays and can be configured.
Download this JSON response here:
Jira issues example. Descriptor to list Jira issues in a table:
{
"type": "rest",
"uri": "datasource://jira/rest/api/3/search?jql={$initial.jql}&maxResults=5",
"children": [
{
"type": "table",
"path": "issues",
"columns": [
{
"header": "Issue",
"accessor": "key"
},
{
"header": "Summary",
"accessor": "fields.summary"
},
{
"header": "Status",
"accessor": "fields.status.name"
}
]
}
]
}
Configure the datasource
The uri section starts with datasource://[YOUR_DATASOURCE_VARIABLE_NAME], in our example, jira and following, the rest of the URI rest/api/3/search . Select your previously created datasource from the dropdown. In our example Jira Cloud datasource.
Optionally, you can define variables to pass to your request. In the Jira example, the variable {$initial.jql} which is used in the query as a parameter jql={$initial.jql}. Then, in the input field for our variable jql we are using issuetype = Bug as an example.
The response from the API will be mapped to a table.
Define the columns in the table by mapping attributes and fields returned by the API:
key: maps to the issue key.fields.summary: maps to the issue summary field.fields.status.name: maps to the issue status name.
Save the report configuration.
