How to configure Insight custom fields as cascading select list
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
To configure Insight custom fields as cascading select list
Example
Based on a schema with object types below,
You would like to have 2 custom fields on a request form to allow users to
Choose an Author object in the first field
Choose the Book object(s) in the second field. The options in this field should be based on the selected value in the first field.
Solution
There are 2 solutions with different combinations of Insight custom field types
Using an Insight custom field and an Insight referenced custom field
Create a default Insight custom field for users to select author with the configurations below.
Create a referenced Insight custom field for users to select books written by the author chosen in the custom field above. For this example, we select the field type that allows multiple option.
Reference type: At the time of the screenshot is taken, the bug [JSDSERVER-8342] Changes are not reflected in the 'Reference type' option of an Insight Referenced Objects custom field is open. The reference type field will not show the expected value(s) despite it being successfully saved.
Additional Filter Scope (IQL): To ensure that the custom field will only show the expected options, you could specify the additional filter scope as shown in the screenshot below.
Option to add all objects: A handy one to allow users to select all objects just by clicking once.
Make sure both the custom fields are added to the right request type and test it out.
Using two Insight custom fields
Create a default Insight custom field for users to select author with the configurations below.
Create another default Insight custom field with the configurations below.
Tips on constructing the filter issue scope
How to construct the IQL?
View one of the Author object and check the graph. Locate at least one of the objects that is expected to show up as an option and see the direction of the arrow. Is it pointing towards or away from the chosen Author object? In this example, they are all pointing towards the Author object and hence, we are looking for object having outbound references of Author. And to make sure only Book objects are showing as options, we add the condition for object type in the IQL.
Example object graph
Why "Key=${Author}" instead of "Label=${Author}" or "Name=${Author}"?
The value returned from the Author custom field is in object key format and hence, it needs to be matched using key.
Was this helpful?