Define fields on reference list

Data Integrity Suite
Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2025

Reference items are displayed in the {Code} field by default. These are the values that are displayed as list options when the reference list is used on an asset.

Allowed fields on a reference list

You can include one of the following field types within a reference list:

Create a field for a reference list

  1. Navigate to Configuration > Catalog > Reference Lists.
  2. To add a new field to a selected reference list, there are two ways:
    1. From reference lists page:
      1. Click the reference list row.
      2. Information panel for that reference list opens on the right.
      3. Select the Fields tab and click the + (Create Field) button.
    2. On the reference lists page:
      1. On the reference lists page, click reference list's name to open its Details page.
      2. Select the Fields tab and click the Create Field button.
  3. In the Create Field dialog, choose a Field Type from the list.
  4. Configure the following settings for the selected field type as required. The additional settings that are available will vary depending on the selected field type.
    • Field Name: A name for the field.
    • API Name: Represents the name that is referenced when loading data using the API and it must be unique. It is automatically generated based on the value that you enter for the Field Name.
      Warning: You cannot define a field with an API Name of KeyPath, Path, or DisplayPath. Additionally, you cannot change an API name after the field type has been saved.
    • Category: The category that the field will be included in.
    • Field Description: To display in a tool tip when hovering over the field.
    • Listable: Determines whether or not the field appears as a column in the list view of reference lists. You can set the value for this attribute to either True or False, indicating whether the field should be displayed in the list view.
    • Requirement: Sets whether or not a particular field is required when completing a form. Choose from:
      • Required: Sets whether or not a particular field is required.
      • Key: Sets whether or not a field is a 'key field' for the selected reference list. A key field is a field in a record that contains unique data which can be used to distinguish that record from all other records.
      • Optional: You can choose this if you would like to keep it as an optional requirement.
    • Show In Details Tab: Determines whether or not the field appears on the reference list detail page and the Information side panel.
      • If this option is not selected, the field is hidden from the Details tab.

      • Display in Column: If Show In Details Tab is checked, you can select Display in Column to display the field in a column on the reference list detail page. Multiple adjacent columns are displayed on the same line and the fields will automatically adjust to fit the page. If you have a large number of fields and you want specific fields to be in the same row, use the up and down arrows on the Fields tab to set the order that they will be displayed on the reference list detail page. Alternatively, you can group the fields into a category to ensure that they are displayed together. If Display in Column is not checked, the field is displayed using the full width of the page.

    • Show if Empty: If this option is selected, the field will always be displayed on an reference list detail page, even if there is no specified value. This option is not selected by default. The default behavior is to only display fields that have specified values.
    • Persist in Filters: If selected, the field appears as a persistent filter in the list of reference lists.
  5. Once all the settings are configured, click Create Field to save the new field. You can also click on Add and Create Another to save the current field and immediately start creating a new one.

These menu options are available when you click the ellipsis next to a field:
  • Move To Top: To move the field to the top of the list.
  • Move Up: To move the field up by a row.
  • Move Down: To move the field down by a row.
  • Move To Bottom: To move the field to the bottom or end of the list.

Edit a field of a reference list

Note: Not all fields are available for edit.
  1. Navigate to Configuration > Catalog > Reference Lists and click the reference list name.
  2. Select Fields tab and click the ellipsis next to a field name in the list view and select Edit.
  3. Alternatively, you can click the row for the desired reference list to open its Information panel and click Fields tab in the panel.
  4. An Edit Field dialog box with existing field details will appear.
  5. Modify the details of the field as required and click Save.

Delete a field of a reference list

Warning: Ensure that you actually want to delete the field. A successful deletion cannot be undone.
  1. Navigate to Configuration > Catalog > Reference Lists and click the reference list name.
  2. Select Fields tab and click the ellipsis next to a field name and select Delete.
  3. A dialog box asking for confirmation will appear. To proceed, click Delete.