Adding a data reference to a form

Add a data reference to a form to prompt users with a list of data records.

For example, you can reference the Vehicle data type on an accident claim form to display a list of car models. By using data references, you integrate data with cases in your application.

To add a data reference:

1. Open a case type in Case Designer, and click a step in a stage.

2. Click Configure form to open Form Builder.

3. Click + Add field.

   In the autocomplete field that is displayed, enter a unique label.

   Do not use px, py, or pz prefixes in a label because they are reserved.

4. From the first drop-down list, select Data reference.

5. From the second drop-down list, select a display mode that is supported by your field type.

   Display modes include:

   • Optional — Users do not need to enter a value in the field to submit the form.

     This is the default display mode.

   • Required — Users must enter a value in the field to submit the form.

   • Read-only — Users can view the value in the field but cannot edit it.

   • Calculated (read-only) — Users do not enter values in the field.

     The value of the field is determined by a declare expression at run time.

6. From the third drop-down list, select the name of a data type.

7. Optional: Add read-only fields to the form that are displayed when a user selects a data record.

   To add read-only fields:

   1. Click + Add field to [data type].

   2. Select a property from the drop-down list.

      This list is populated with properties that are defined in the data type.

   3. Repeat steps 1 through 2 to add more read-only fields.

8. Optional: Drag a field to change its position on the form.

9. Click Submit.

At run time, an autocomplete field is displayed that contains a list of data records. Users can search for a data record by entering text in the field.

Tip: Click the gear icon to configure your data reference with more options.

Related information

Open topic with navigation