Forms provide a natural grouping and layout for Templates, often reflecting the stages or phases of the process being followed. Each Form contains one or more Template.
- Title: What is the name of the Form that will appear in the Record menu on the left hand-side?
- Identifier: What is the unique identifier for the Form? This is auto-generated, but can then be overwritten if required. This is typically the same as the Title but it cannot contain gaps.
- Form order: What is the order for each of the Forms in the menu on the left-hand-side? This will typically reflect the process being captured in the app.
- Display order: What is the order in which Templates will be displayed on this form?
- Template: Which template will appear against each order item?
Form rules allow you to specify a filter which is used to define under what conditions the form will be hidden, and which teams it will be hidden from. This is a Version 18 feature only but will be detailed below:
The generic initial syntax for a form rule is $filter= however, from here how you structure the remainder of the expression will depend on the Field in question. Whether or not you want the expression to evaluate the Field as equal to (eq) or not equal to (ne) a certain value will also have an impact.
$filter=[BitFieldIdentifier] eq true: This will hide the Form in question if the referenced Bit Field is checked (true).
$filter=[BitFieldIdentifier] eq false: This will hide the Form in question if the referenced Bit Field is not checked (false).
$filter=[TextFieldIdentifier] eq 'Text': This will hide the Form in question if the referenced Text Field is equal to the quoted text.
$filter=[TextFieldIdentifier] ne 'Text': This will hide the Form in question if the referenced Text Field is not equal to the quoted text.
These types of Fields have two Fields created, a main Value Field and an _Text backing Field that holds the text for the option. For example I could have High and Low as the Text Fields (options) in a Select List but their values could be 5 and 0 respectively. Hence, you can either reference the _Text Field or the Value Field:
$filter=[SelectonFieldIdentifier_Text] eq 'Option Text'
$filter=[SelectonFieldIdentifier] eq 'Option Value'
Like with all Form Rules the equivalent ne (not equal to) version of these expressions can be used if desired also.
$filter=[NumberFieldIdentifier] eq The desired number
$filter=[NumberFieldIdentifier] ne The desired number
Example - If you wanted to hide a form when a Number field equalled 10:
$filter=[NumberFieldIdentifier] eq 10
- When numbering the display order leave gaps (e.g. use 5, 10, 15… instead of 1, 2, 3…) so that you can easily insert new Forms without having to change the entire display order.
- Use the Checklist in the Overview section to ensure all Templates have been added to one or more of the Forms.