Referenced Insight custom field

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

Referenced Insight custom field allows you to specify a parent custom field and then shows objects that have references to or from the object chosen in the parent field.

Example

Parent field: Affected serverReferenceReferenced field: Affected part
Biggest server in the server roomCPU

Intel(R) Xeon(R) CPU E7- 4830 @ 2.13GHz

Network interface

Apc Network Management Card 2

Memory

32GB DDR4-2400 ECC REG DIMM

The objects available in your referenced custom field will change depending on what the user has chosen in the parent custom field.

Creating a referenced custom field

To create a referenced custom field:

  1. Log in as the Jira administrator.
  2. Go to Administration > Custom fields.
  3. Click Add custom field, and select Advanced.
  4. Search for Insight Referenced Object, and select either the single- or multi-select field.
  5. Enter a name and description for your field.
  6. Associate the custom field with desired screens in Jira.

Configuring a referenced custom field

With your custom field created and associated with the right screens in Jira, you can now configure how it will behave.

  1. Find your custom field on the Custom fields page, and click Configure next to it.
  2. Select Edit Insight Configuration.
  3. Select which object schema the custom field should use.
  4. Configure other settings. You can check what they mean in the table below.

SettingDescription
Scope
Parent custom field

Select the parent custom field. Your referenced custom field will return objects based on what was chosen in the parent custom field.

Reference direction

Select the direction of the references:

  • Outbound references: All references that exist on the object chosen in the parent custom field. This would typically include all attributes of type Objects, which means references to other Insight objects.
  • Inbound references: All references from other objects that go to the object chosen in the parent custom field.
Reference type

Reference type. You can choose any type that you have configured in Insight or leave it blank to use all references.


Restrict to user related object

You can restrict this custom field to just show objects related to the Jira users filling in data for this field. You can additionally restrict it to a specific user by using IQL.

For more info on creating your queries, see IQL - Insight Query Language.

Restrict to project related objects

You can restrict this custom field to just show objects related to a project where this field is used.

Additional filter scope (IQL)

You can filter objects on attributes to select only those that fit your needs.

An example:

Status = Active

For more info on creating your queries, see IQL - Insight Query Language.

Filter issue scope (IQL)

In the create/edit view, and in the customer portal, you can filter objects based on their attributes, in addition to the filter scope you configured above. This doesn't apply to JQL searches. Placeholders are supported, but only for "Select type".

Here's an example:

"System Owner".User = currentReporter()

For more info on creating your queries, see IQL - Insight Query Language.

User interaction
Filter objects with attributes

You can specify the attributes to filter on, this field is mandatory and at least one has to be configured. Label is default.

Object attributes on issue view

You can specify which of the object's attributes will be displayed in a Jira issue. For example, you might specify only the most important attributes, so as to not clutter your issues, and users can view the rest after opening the object.

Service Desk
Show object picker on customer portals

This is for Jira Service Management. You can choose whether the object picker (which allows to browse and select objects) should be available on the customer portal.

Enabling access for customers

When you add Insight custom fields to Jira Service Management, you need to enable them for customer portals. Without these steps, customers won't be able to access these fields. Learn more...


Last modified on Dec 1, 2021

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.