• Products
  • Get started
  • Documentation
  • Resources

Configure the Insight object field

To connect Jira issues with Insight objects, you need to be a Jira admin and have permission to access and edit schemas. Learn more about permissions.

You can use the Insight object field to view Insight objects in Jira Service Management. To choose which objects the Insight object field will display you can configure the field in three different ways:

  • use Object schema to filter objects by object schema

  • use Filter Scope (IQL) to filter objects based on information from Insight

  • use Filter Issue Scope (IQL) to filter objects based on information from the current issue

Use the Object schema field

Use the Object schema field to select which object schema will be linked to this Insight object field. This field is required.

If you have selected objects from a different object schema in the Filter Scope (IQL) field, only objects in this object schema will be displayed.

Use the Filter Scope (IQL) field

Use the Filter Scope (IQL) field to filter Insight objects based upon information from Insight.

This field is optional. You cannot use placeholders in this field.

For example, if you wanted to create an Insight object field that only displayed certain models of laptop, based on a certain manufacturer, you could enter the IQL query objectType = “Laptop” AND Manufacturer = “Apple” to show only these objects.

Use the Filter Issue Scope (IQL) field

Use the Filter Issue Scope (IQL) field to filter your data using information from within the issue itself - based on other Insight object fields or Jira system fields that contain information about the issue.

This field is optional. You can use placeholders in this field. Learn more about placeholders.

Filter using object fields from within the issue

You can use the Filter Issue Scope (IQL) field to reference Insight object fields from within the issue. This can be used to link together two or more Insight object fields and create a cascading list.

For example, if you wanted to create an Insight object field that only displays certain models of laptop based on the manufacturer you’ve selected in another custom field, you would create two separate Insight Object fields.

Create your first Insight Object field and name it “Manufacturer”. Configure the field to show only “Manufacturer” objects retrieved from Insight by setting the Filter Scope (IQL) to objectType = “Manufacturer”.

Now create the second Insight Object field and name it “Model”. Configure the Filter Issue Scope (IQL) to show only the models of laptop from the manufacturer field in the issue by typing objectType = “Laptop” AND Manufacturer = ${customfield_xxxxx.label} where “xxxxx” is the custom field ID of the “Manufacturer” custom field.

Now the “Model” field will show only the laptops that correspond to that manufacturer.

When using the Filter Issue Scope (IQL) field, you must use the custom field ID (“customfield_xxxxx”) to identify custom fields and not the custom field name (“Manufacturer”).

Filter using system fields from within the issue

You can use the Filter Issue Scope (IQL) field to reference system fields from within the issue like “Assignee” and “Project”.

For example, if you wanted to only show a list of laptops owned by the current Assignee, you could configure the Filter Issue Scope (IQL) field by typing objectType = “Laptop” AND "Owner" LIKE ${assignee.label}. In this case, each laptop would have an “Owner” attribute that corresponds to the name of the assignees in Jira.

Some Jira fields can hold multiple values, while others can only hold a single value. You can refer to Jira fields using either the field value label or ID:

Issue key

Label / Description

Multiple

Type

${key.id}

${key.label}

assignee

Assignee

false

ApplicationUser

userKey

Display Name

duedate

Due Date

false

Date

duedate

duedate

fixVersions

Fix Versions

true

String/Custom Insight object

Id

Name

issuetype

Issue Type

false

String/Custom Insight object

Id

Name

components

Components

true

String/Custom Insight object

Id

Name

priority

Priority

false

String/Custom Insight object

Id

Name

pid

Project

false

String/Custom Insight object

Id

Name

reporter

Reporter

false

ApplicationUser

userKey

Display Name

resolution

Resolution

false

String/Custom Insight object

Id

Name

summary

Summary

false

String

summary

summary

Insight in Jira Service Management does not include the system field types that are included with Insight for Insight in Jira Service Management DC.

If you want to search on these system field types, you must either create Insight objects modelling these fields (ie. you will need to create your own ProjectComponent Insight object) and set them as a value in another custom field, OR you can use the field labels and/or IDs.

Using placeholders with multiple values

In the above example, we are referencing the value of the manufacturer field ${customfield_xxxxx.label} (where “xxxxx” is the custom field ID of the “Manufacturer” custom field) by using a placeholder. Placeholders simply replace the text in the query with other text when the query is executed.

Placeholders can return a single value, such as ${customfield_xxxxx.label}.

If the field holds multiple values, the placeholder can return a single value by using an index (${customfield_xxxxx${1}}) or it can return all of the values at once by using a query like Manufacturer IN (${customfield_xxxxx${0}}).

The use of placeholders is not supported inside an Automation flow.

 

Last modified on Jul 7, 2021
Cached at 10:33 PM on Oct 20, 2021 |

Additional Help