Skip to content

Autocomplete

The autocomplete field provides suggestions to the user based on the field label of the referenced document. It functions similarly to a reference field but does not establish a direct link between the autocomplete field and the referenced document. The autocomplete field persists the label of the referenced document as a string value, whereas the reference field stores the document ID of the referenced document. Unlike a reference field, updates to the referenced document do not affect the autocomplete field's value. The autocomplete field also allows free-text input.

Properties

Property Required Purpose
Reference Type Yes Specifies whether there are references to one or more documents. For references to a single document, select the one-on-one (1-1) option. For references to multiple documents, choose the one-to-many (1-N) option.
Document Definition Yes Specifies the document definition to refer to. Note that it's not possible to remove a document definition if it's referenced by another document definition.
Reference Label Yes Defines the label to be displayed for the options in the reference list. BizzStream text expressions can be used for dynamic labels. For example: `{{F["name"]}} - {{F["code"]}}
Filter No Filters the list of options available to the user based on a BizzStream filter expression. For example, only show documents with a particular status.
Search Method Yes Specifies how the user can search the options. It can be set to "contains," "starts with," or "ends with."
Sort Field No Determines the sorting order of the options presented to the user. The options are sorted based on the selected field's values within the referenced document.
Sort Order No Specifies whether the sorting order is ascending or descending.
Allow Free Input No If checked, allows end users to provide their own input as a field value.