Read-only Insight custom field

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

Read-only custom fields allow you to include information about objects in your issues. This information can only be viewed and can’t be edited.

Example

An example of how you can use a read-only custom field is during employee offboarding. The custom field can display the employee's current assets in the offboarding issue, so you know what needs to be collected before they leave.

To create and configure read-only Assets custom fields, you must be logged in as a user with Jira Administrator or Jira System Administrator permissions.

Creating a read-only custom field

  1. Go to Administration > Issues > Custom fields
  2. Click Add custom field and then select Advanced.
  3. Search for Insight readonly object/s and select it.
  4. Enter a name and description for your field.
  5. Associate the custom field with desired screens in Jira.

Configuring the read-only custom field

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

  1. Go to Administration > Issues > Custom fields.

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


SettingDescription
Scope
Object schemaThe object schema that the custom field should use. If you want this field to refer to specific objects, make sure you point to the right schema.
Filter scope (IQL)

The general filter for the custom field. Use AQL to specify which objects you want to show in this field. Learn more about AQL

Examples

If you want to show objects that belong to the “Computer” object type, use the following AQL:

objectType = "Computer"

If you want to show software that is created by Atlassian, try something like this:


Filter assign scope (IQL)

This filter is used to automatically add objects to your custom field based on values in issue fields or another Assets custom field. To get the values from these fields, use placeholders. Learn more about placeholders

Important

  • To see a value in your read-only custom field, you must enter an AQL query here. This is the only way to populate the custom field.

  • The object is added to your custom field automatically only when an issue is created or edited.

Example

If your custom field is filtered to show the “Computer” object type and you want to display the computer that is owned by the reporter of the issue, there are two AQL queries that you can use:

Owner = currentReporter()
Owner = ${reporter}
User interaction
Object attributes on issue view

This is where you can specify which attributes of the object displayed in your custom field you want to show in the Jira issue.

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 Nov 24, 2022

Was this helpful?

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