Supported UI Components for Assistants

Use the following UI components to build a custom assistant.

Fields

Use fields to display and collect data. Fields are added to the current step on an on demand basis. For more information, see Assistant.addField(options).

Field Groups

Use field groups to manage and organize the fields in a step. For more information about field groups, see Assistant.addFieldGroup(options). Additionally, field groups can be collapsed to save space on the page. For more information, see FieldGroup.isCollapsed and FieldGroup.isCollapsible.

Sublists

Use a sublist to display the results of a saved search.

Note:

INLINEEDITOR is the only sublist type supported by the assistant page type.

For more information, see Assistant.addSublist(options).

Buttons

You do not need to add buttons to an assistant unlike the form and list page types. Buttons are automatically generated by the assistant.

Steps

Steps are the primary UI components used when creating an assistant because they define each page of the assistant. Step sequence, placement, and positioning can be specified using the following properties.

  • To add a step to your assistant, see Assistant.addStep(options).

  • To indicate whether the steps must be completed in a particular order, see Assistant.isNotOrdered.

    Note:

    Ordered steps appear vertically along the left side of the assistant, while unordered steps appear horizontally across the top of the assistant.

  • To add help text to your steps, see AssistantStep.helpText.

General Notices