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 as needed. For more information, see Assistant.addField(options).

Field Groups

Use field groups to organize fields in a step. For more information, see Assistant.addFieldGroup(options).

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 show 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

Unlike form and list page types, you don’t need to add buttons to an assistant. Buttons are generated automatically.

Steps

Steps are the main UI components in an assistant because they define each page. You can set step sequence, placement, and positioning with these 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. Unordered steps show up horizontally at the top of the assistant.

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

General Notices