Insight (now Assets) Integration
- Nisha Shantilal
Power BI Connector app integrates with Insight (now Assets) in Jira Service Management. This integration further extends the capabilities of Insight asset and configuration management in the Jira cloud and DC/Server to visualize the required data for actionable insights in Microsoft Power BI. With this integration, Insight Attributes and Insight Types fields information can be imported to Microsoft Power BI.
Power BI Connector Cloud and DC/Server app (version 4.1.0 and above) offers Insight integration.
Power BI Connector requires Microsoft Power BI Desktop software to function.
Pre-requisite to use Insight (Assets):
To use Assets for the Jira Cloud, you need to have Jira Service Management Cloud Premium or Enterprise. For more information, refer to Assets in Jira Service Management.
To use Assets for the Jira Data Center, you need to install Jira Service Management Data Center 4.15 or above. For more information, refer to Assets for Jira Service Management Data Center.
Steps to integrate Power BI Connector and Insight in Jira Service Management
Insight is now called Assets. For more information, refer to Insight is now called Assets.
It is required to define a custom field in Jira to import the values of Insight Attributes and Insight Types.
Navigate to Jira > Power BI Connector > Connectors > My Connectors.
2. To add a new connector to pull the required Insight fields, click Add New Connector. For more information about creating Connector URLs, refer to My Connectors.
3. A form is presented with Jira and JSM fields to create the Connector URL. The Insight Attributes and Insight Types list the insight fields.
Set up the connector for the Insight (Asset) fields
The steps below illustrate how to fetch the Insight (Asset) data to import into Microsoft Power BI.
Power BI Connector Cloud
a. To import the Insight data, you must set up the Email and API Token once. Enter the Email and API Token to grant access to Insight data and select the required Insight fields for the Connector URL. To save the Connector details, click Save and Close.
b. Insight Attributes
Insight Attributes define an Insight object type. Each object type has its own set of attributes. For more information, refer to Understand how Assets is structured.
AQL for Insight (Asset) Objects: Provide the AQL query to filter the Insight Objects data. To validate the AQL, click Validate AQL Syntax. On successful validation, an appears.
Select the required Insight Attributes to import.
c. Insight Types
Insight Types defines the objects that the object schema contains. For more information, refer to Understand how Assets is structured.
Insight (Asset) Object Schemas: The Insight (Asset) Object Schemas drop-down lists all the available Object schemas in the Assets. The default value is All schemas.
You can select one or multiple Insight Object Schemas.
The Insight Object Schemas drop-down value is set to the default value of All schemas if:
None of the Object schemas is selected.
The selection consists of All schemas and any other Object Schemas.
Select the required Insight Type fields to import.
d. To save the connector details, click Save and Close. To know about the checks performed while saving the connector, refer to Form validation.
Power BI Connector Data Center
a. To import the Insight data, select the required Insight fields for the Connector URL. To save the Connector details, click Save and Close.
b. Insight Attributes
Insight Attributes define an Insight object type. Each object type has its own set of attributes. For more information, refer to Understand how Assets is structured.
AQL for Insight (Asset) Objects: Provide the AQL query to filter the Insight Objects data. To validate the AQL, click Validate AQL Syntax. On successful validation, an appears.
Select the required Insight attributes to import.
c. Insight Types
Insight type defines the objects that the object schema contains. For more information, refer to Understand how Assets is structured.
Insight (Asset) Object Schemas: The Insight Object Schemas drop-down lists all the available Object schemas in the Assets. The default value is All schemas. Select the Object Schemas.
Select the required Insight Type fields to import.
d. To save the connector details, click Save and Close. To know about the checks performed while saving the connector, refer to Form validation.
Import into Power BI
To import the Insight data into Power BI, refer to Import into Power BI.
The Insight data imported through the Connector URL appears in Power BI as tables.
Form validation
On the click of Save and Close, the form is validated for the Email and API Token and the AQL syntax in sequence before saving the connector.
The error message is displayed if the Email or API Token values are invalid. To proceed to the next step, provide valid credentials.
The AQL syntax is validated once the Email and API Token pass the validation check. The error message is displayed if the AQL syntax is not valid. For more information about error handling, refer to AQL syntax validation.
How to use Asset Query Language syntax?
Assets Query Language (AQL) is a language format used in Assets in Jira Service Management to create search queries for one or more objects.
Basic syntax
The basic syntax of an AQL query is <attribute> <operator> <value/function>. The query returns one or more objects when the attributes of these objects match the operator and value specified.
Example | Query |
|---|---|
Limit the search result to a specific object schema name. | objectSchema = "ITSM Schema" |
Limit the search result on object schema ids. | objectSchemaId in (1, 2) |
Limit the search result to a specific object type. | objectType = "Employment Start Date" |
Limit the search result on object type ids. | |
Search all attributes on all objects for a relevant match. | |
Limit the search to the object having any inbound references to it. | |
Find an object by object Id. |
AQL syntax validation
The Assets app manages the AQL syntax validation and error messages.
Once you provide an AQL query, to validate the syntax, click Validate AQL Syntax.
If the AQL syntax is correct, then is displayed.
If the AQL syntax is not correct, an error message is displayed. To proceed to the next step, provide valid AQL query syntax.
A few error messages are listed below based on the type of syntax errors.
Example | Query provided with invalid syntax | Error message |
|---|---|---|
Limit the search result to a specific object schema name. | ||
Limit the search result on object schema ids. | ||
Limit the search result to a specific object type. |