References on Forms

The References standard form element indicates that the current object has been referenced on other objects through a relationship. Administrators can configure this element to display those other objects as dropdown menus or tables, through which end users can search for and/or create new objects. Before the reference element can be added to a form, the form's object type must be added to a relationship on another object type. See Add References to an Object Type for more information.

The data available in the References element belongs to the object type(s) where the relationship was originally saved. For example, if the Vehicle object type is saved in a relationship on the Incident object type, the data displayed on the form will be from Incident.

By default, references are added to the form canvas as a dropdown menu, displaying its name (versus the original relationship's long name), but you can configure the element to choose how the reference is displayed, which functionality is available, and which form is displayed when creating a new object.References on a form displayed as both a table and dropdown menu.

Administrators can also select the Enable Advanced option when configuring references on a form. This option will open a palette with advanced search options for users to select existing objects and assessment objects, if any, to add to the reference. Enabling the advanced option displays a palette for users adding existing objects to a relationship. 

To configure a reference on a standard form:

  1. If needed, open the form you wish to add the reference element to by clicking the icon in the top bar > Configurable Forms in the Views section, then selecting a form.
  2. After adding the reference element to your form, hover your cursor over the reference on the canvas, then click the icon to open the Edit Component Display screen.The reference element settings.
  3. Click Display ‘Long Name’ if you want to display the long name of the originating relationship on the form. To add or edit the relationship's long name, open the Edit Object Type page where the original relationship was  created, click the Relationships tab, then click the relationship to open the Edit Relationship palette. 
  4. Click the  icon beside Enable Search if you want to disable the end user's ability to search for existing objects in the reference.
  5. Click the icon beside Enable Create if you want to disable the end user's ability to create new objects through the reference.
    Disabling both Search and Create functionality on a reference will make the element read-only.
  6. Click the  icon beside Enable Advanced to display the advanced user interface for the relationship on a form. When this option is enabled, clicking Add Existing [Object] will open a palette that allows users to search for and select one or more objects or assessment objects (if any) to add to the reference.The highlighted reference table demonstrating how the advanced display appears on a form, whereas the reference above it is displaying the default interface.
  7. To display the reference as a dropdown menu, leave Dropdown selected under View Relationship as: (this option is selected by default).
  8. To display the reference as a table:
    1. Select Table under View Relationship as: then click to select the properties and fields from the reference object type that you want to include on the table as columns (e.g. if the Vehicle object type is referenced in a relationship on the Incident object type, you can display properties and fields from Incident in the table). The columns will appear on the table in the order they were selected in the Build Relationship Table settings.Selecting the properties and fields that will appear on the  table as columns.
      Reference tables with more than 10,000 rows of data will not load correctly. For larger data sets, it's recommended that a Form Action element is added to a form to redirect users to view the data in a report.
    2. Optional: Select the Display colored cells as ovals checkbox to show formula or select list cells as text with colored circles instead of a full background color. When this option is not selected, cells are displayed with text and a full background color, if any.
  9. For both the dropdown and table options, below Object Type Forms, select the form the users will complete if they're creating a new object through the reference.
    Selecting the configurable form that will be displayed when an end user creates a new object through the reference.
    If no configurable form(s) have been created for the object type(s) in the relationship, the default form(s) will be selected automatically.
  10. Click Close when finished.