Common Omniscript Element Properties

Each Omniscript element has settings, some of which are unique to that element. Some settings are common among the elements, though some of these setting aren’t available in all elements. To edit these settings, use the Properties pane on the Designer.

Property	Description
Add Condition	Add additional test conditions to an element's Conditional View. See Conditionally Display Omniscript Elements.
Add Group	Group conditions to create complex expressions. A group enables a set of conditionals to have a separate AND/OR operator. For example, you can connect two groups with OR, but inside of each group you can use AND to ensure the group tests are true.
Available For Prefill When Hidden	Data JSON can prefill the element when it’s hidden by a conditional.
Autocomplete Input	Enable users to automatically complete values according to the input's information type. For example, adding `tel` to a Telephone input element enables automatic completion for phone numbers. For a full list of attributes, see HTML attribute: autocomplete.
Conditional View	If conditions in this field are met, the element displays become editable or are marked as required. The Value field supports merge syntax. See Conditionally Display Omniscript Elements.
Conditional Type	Condition types determine whether an element shows disables read only or becomes required when the conditions evaluate to true. See Conditionally Display Omniscript Elements.
Control Width	Displays the width of the control on the page, using a range of 1-12.
Default Value	Sets a default value for the element. If the element has been prefilled with a value, the default value doesn’t overwrite the prefilled value. Supports merge syntax. Set a Default Value for an Omniscript Element
Element Name	The unique identifier for the element. Element Names can’t contain spaces and must be unique in an Omniscript.
Field Width	Displayed if the Label outside of field checkbox is checked. Specifies the width of the input field separate from the Control Width. Useful if the label is longer than the expected input.
Help Text	The text displayed when the user hovers over the help icon.
Help	Determines if a help icon is displayed to the user.
Help Text Position	Specifies the help text's position.
Internal Notes	Add notes about this element for reference during design. Internal notes appear only in the Omniscript designer and aren't shown to users at runtime. The field is labeled Internal Notes for Step elements and Notes for all other Omniscript elements. After editing and saving the field in the Omniscript designer, refresh the designer and select the element again to see the updated value. At runtime, the saved value is visible but cannot be edited.
Label outside of field	For input components, specifies whether the label displays outside the field. Valid only when using the Lightning Experience.
Label	Display a label for the control.
Mask	Sets the format for user input. Use A for any letter, 9 for any number, * for any character, and [ ] to enclose optional characters. For example, (999) 999-9999 matches any US-based phone number. For more information about patterns, see Pattern Mask at https://imask.js.org/guide.html#masked-pattern. When you set the Mask property on text fields, Salesforce shows the default error message instead of custom error messages for those fields.
Maximum Length	Maximum number of characters the user can enter.
Minimum Length	Minimum number of characters the user can enter.
Options	An array of input selections for dropdown, multi-select, and radio button controls.
Pattern Error Text	Message displayed if the input doesn’t match the expression.
Pattern	The pattern flag is used to enforce data validation before submitting. Currently, complex patterns aren’t supported, but simple pattern matching works. The patterns accept regular expressions (regex), and custom error text.
Placeholder	Displays placeholder text in empty fields. Placeholder text isn’t applicable if masking is enabled.
Read-Only	If true, the user can’t modify the value in the field.
Copy Elements Repeat (in the designer for a managed package)	If true for an element or block, a user can click + to copy the element or blocks of elements on the form. Prefill Repeatable Blocks
Clone When Repeating Repeat Clone (in the designer for a managed package)	If true, any values from the element or block of elements are copied to repeated instances of the element or block.
Limit Repeat	Specifies the number of times this element can be repeated. For example, to set a maximum of two repetitions, set Repeat Limit to 1.
Required	Specifies whether the user must enter a value in order to submit the form.
Show/Hide Operator	Determines whether multiple conditions must be met to render an Omniscript. When set to All Conditions Are Met, an AND operator checks if all conditions are valid. When set to Any Condition Is Met, an OR operator checks if any of the conditions are valid.
Show Message As	Display the message inline or as a toast.
Toast Mode	Determines the persistence of the toast. Sticky mode shows the toast until the user closes the message. Pester displays the toast for three seconds. Dismissable displays the toast for three seconds or until the user closes it.
Extra Payload	Sends additional Key/Value pairs. Supports merge field syntax.
Remote Class	Specify a Vlocity Open Interface Class.
Remote Method	Specify a Vlocity Open Interface Method.
Remote Options	Key/value pairs that specify additional class invocation options.