Reference Qualifiers

1 min

A reference qualifier filters the available records shown on a reference field’s selection. For example, if you need to restrict the available options on a form’s field referencing the Location table, you would need to configure a Reference qualifier for that reference field.

For equivalent functionality on the Service Catalog, please refer to Reference filterReference filter.

Create a reference qualifier

To create, navigate to Application > Field > Reference qualifiers and populate the following:

Field Name	Description	Sample value
Name	Name of the reference qualifier	Incident - Location based on selected Company
Table	Table that has the field this reference qualifier applies to	Incident
Field	Field on the Table that this reference qualifier applies to, e.g. out of box there is an Incident’s field named Location that is referencing Location Table, and we are using it as an example here.	Location
Active	If set to “Yes”, this reference qualifier is applied to the nominated Field	Yes
Target table	[Auto populated] Table referenced by the Field. The reference qualifier runs configured query/condition on this table	Location
Description	Extra information about the reference qualifier for administrative purposes	Locations shown are the ones for the Company selected on the Incident record
Advanced	If Yes, script is required	No
Condition	Condition builder, runs on the Target table (in this example, Location), NOT the Table that has the reference field that this qualifier is for.
Script	When you need to qualify based on another field’s values on a record or any other condition that condition builder above does not support, you will need to select “Advanced” as “Yes” and then populate the Script field. On the script: Like the Condition builder, also runs on the Target table (in this example, Location) The current record being viewed, is accessible with all the current values to the fields, as an object called “current” You will need to return a Table record query. It should be noted The script below returns Table API query to run against the Location reference field’s referenced table, i.e. table named Location When you edit an Incident record and click on the Location reference field, the Reference qualifier will run and “current” in the script below refers to the Incident record. Therefore, for context, the script is looking for Company value of the Incident record. The example to the right results in: When viewing or working on an Incident, if the Incident’s Company field has been populated, the Incident’s Location field will only show Locations that have their Selectable field set as Yes and Company the same as the Incident’s Company. If the Incident does not have Company populated, the Incident’s Location field will show Locations that have Selectable as Yes. For more information about Table record query, please visit Table API (Server)	if (current.Company.hasValue()) { AND ( EQUAL("Company", current.Company.value()), EQUAL("Selectable", true) );} else { EQUAL("Selectable", true);}