Intelligent Agent Core User Guide

Please email support@awaken.io for omissions or errors.
×
Menu
Search
 
   
   
   
 

List Box

 
The List Box Control allows an agent to easily select option(s) from a list. The list can be static, or sourced dynamically from a database, file, API web service, or Field or Variable. Depending on configuration, it can be compared with either the Radio Button, Check Box, or Table.
 
 
 
This Control is part of the Intermediate Control pack, and will only be available if your System has the appropriate licence.
 
 

How To

Add a List Box to the Page. The options and style can be configured in the Options tab and Styling tab of the Field Properties, and Validation can be applied if desired.
 
List Box Fields can be styled in a Stylesheet by referencing the control-list-box class.
 
To configure the available options, use the Datasource Wizard in the Advanced Options tab.
 
The List Box Control has two unique options available in its Options tab:
Option
Description
Maximum Items in List
This specifies the maximum number of items that can be displayed in the List Box. If more rows than this value are provided or returned, then they will be truncated to this count when the Workflow is run.
Multiple Selection
If enabled, then the agent will be able to select more than one option by Ctrl-clicking multiple rows.
 
 

Notes

The data displayed within the Designer will be the first 10 rows that were returned during the configuration process when the List Box was last saved after completing the Datasource Wizard. If there are more than 10 rows, the Designer will then display a final "..." row to indicate that further data hasn't been displayed. This has no impact on the return of all data when running the Workflow (either as a preview or as a record), with the content then only being limited by the configured data source and the specified value of the Maximum Items in List option.
 
When multiple options are selected, their values are combined in the Field's value as a separated list (using the character specified in the Multiple Selection Value Separator option) in the order that they are selected.
 
If using a dynamic data source, the List Box can also be refreshed by JavaScript or Update Links. Please see the .click() article for more information and an example regarding using JavaScript.
 
The List Box displays in one of two ways: either displaying as a drop-down list (if Display Items is 1), or a multi-line list (if Display Items is greater than 1). If the multi-line display mode is active, then a scroll bar will be displayed beside the list if the number of options is greater than the number in Display Items.