Insight (now Assets) Integration - 4.2.6
- Nisha Shantilal
Tableau Connector Pro for Jira app integrates with Insight in Jira Service Management. This integration further extends the capabilities of Insight asset and configuration management in Jira cloud and DC/Server to visualize the required data for actionable insights in Tableau. With this integration, you can import Insight Attributes and Insight Types field information to Tableau Desktop.
Tableau Connector Pro for Jira Cloud and DC/Server app (version 4.1.0 and above) offers Insight integration.
Tableau Connector Pro for Jira requires Tableau 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 Tableau Connector Pro for Jira 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 > Tableau Pro > My Connector URL and copy the Tableau Web Data Connector URL. For more information, refer to My Connector URL.
2. Navigate to Tableau Desktop > Web Data Connector. Enter the Tableau Web Data Connector URL to Tableau Desktop as a Data Source to import the data into Tableau. For more information, refer to Import into Tableau.
3. Specify the JQL to pull the issues for this data source and click Continue.
4. A form displays the Jira and JSM fields. The Insight Attributes and Insight Types list the Insight fields.
Import the Insight data
Tableau Connector Pro for Jira Cloud
a. To import the Insight data, you need to 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 data source. Click Continue.
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 import the Insight data, click Continue. To know about the checks performed before importing Insight data, refer to Form validation.
Tableau Connector Pro for Jira Data Center
a. To import the Insight data, select the required Insight fields for the data source and click Continue.
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. Click Continue. To know about the checks performed before importing Insight data, refer to Form validation.
Data imported in Tableau Desktop
The Insight data gets imported and appears in a table format in Tableau.
Form validation
On the click of Continue, the form is validated for the Email and API Token and the AQL syntax in sequence before importing the Insight data.
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. |