![]() Intelligent Agent Core User Guide |
|||||
|
|||||
Option
|
Description
|
Access Key
|
If set, the access key allows the agent to focus to this Field's input instantly by pressing the ALT key and the selected alphanumeric key.
|
Auto Click
|
Specifies whether the Field is triggered automatically, and if so then when. Can either be set to Never, immediately after the Page has rendered, or a delay after the Page has finished rendering. For certain Control types, it can also be set to trigger before the Page has started rendering, meaning that the Page will not be delivered to the agent until the Control's action has completed.
|
Button Text
|
Sets the text displayed on the Field's button element. Can reference a Field or Variable, and the value will be inserted at Page load. For example, "Submit for [var_csLastName]".
|
Click Once
|
If enabled, this means that the Field can only be triggered once per Page load. The Field becomes usable again after the Page has been navigated or reloaded. Unlike the Disabled setting, this also prevents the Field from being triggered by JavaScript, rather than just preventing direct agent interaction.
|
Code Description
|
Displays the specified text as a label below the Field in the Designer. This text is never visible to the agent, and is solely used to help guide Users editing the Workflow by making it clear what a Calculate or JavaScript Field does without having to inspect the contained code.
|
Columns
|
Controls like the Check Box and Radio Button can have many options, and display these options in a gridded layout. This allows the number of columns that the options are split across to be specified.
|
Default Value
|
If provided, the Field will automatically have its value set to this whenever the Page is loaded and the Field has no value.
|
Disabled
|
Specifies whether the Field is initially disabled or not when the Page is first loaded, preventing agent interaction with the Field. If enabled, this disables agent input on this Field and visually greys the field out. The Field can still have its value set programmatically via JavaScript, External Links, or Column Mappings. A Field can have its disabled state altered after the Page has loaded by using Helper Functions.
|
Display Error
|
Specifies whether a warning will be displayed to the agent if there is a problem with sourcing the data used in this Field's configuration.
|
Display Items
|
For Controls that contain a list element, this specifies how many of the entries are displayed simultaneously. If set to 1, then it will display as a dropdown list. If set to a number less than the number of entries, then a scrollable list will be displayed. If set to a number greater than the number of entries, then additional blank lines will be added to the end.
|
Field Help
|
Defines a tooltip that will be displayed if the agent hovers their mouse over the Field.
|
Hidden
|
Specifies whether the Field is initially visible or not when the Page is loaded. In the case of Controls that are comprised of multiple elements, there will often be the option to hide all of the elements, or specific elements separately. A Field can have its visibility state altered after the Page has loaded by using Helper Functions.
|
Max Characters
|
Specifies the maximum number of characters that can be input in the Field. Any characters that the agent types beyond this number are simply not added to the Field's value.
|
Mode
|
Specifies how the Email or SMS Field can be interacted with by the agent. Can be set to allow the agent to edit the message body directly, to display the message body to the agent as read-only, or to completely hide the message body from the agent.
|
Multiple Selection Value Separator
|
Specifies the character(s) that will be used to separate the value for each item if multiple items are selected. This will be a comma by default, but can be altered if it's expected that commas will be part of the selected data to avoid unexpected or ambiguous list breaks.
|
Place Labels On
|
Controls like the Check Box and Radio Button can have many options, and display these options in a gridded layout. This specifies where the label for each option is placed relative to its input - or whether a label is displayed at all.
|
Populate on Page Load
|
If enabled, the Field will be populated immediately from the configured data source when the Page loads. If disabled, it will need to be directly triggered in some fashion, for instance via Update Links or a JavaScript .click().
|
Prompt Text
|
If the input for the Field is blank, the specified text will be displayed as faint grey text in the input. It can be used as direction for the agent, with the prompt not being stored as the Field's value, and visually vanishing as soon as the agent enters any text. Can reference a Field or Variable, and the value will be inserted at Page load. For example, "Authorisation for [Order ID]".
|
Read Only
|
Specifies whether the Field is initially read only or not when the Page is first loaded, preventing agent interaction with the Field. If enabled, this disables agent input on this Field with no other visual effect. The Field can still have its value set programmatically via JavaScript, External Links, or Column Mappings. A Field can have its read only state altered after the Page has loaded by using Helper Functions.
|
Sensitive Data
|
If this is enabled, then any data entered into this Field by the agent won't be stored in the Intelligent Agent database. The value can still be used and manipulated on the current Page, but when transitioning from the current Page its value will be lost and it will be blank even if you return to the same Page.
Important: if a Field that is configured as a Link Column and is also configured as sensitive, then it will only be populated if it is on the Start Page of the Workflow, and the value held in the data source may be overwritten with an empty string depending on the integration.
|
Source URL
|
Used in the IFrame and Web Frameset Fields, this is the URL that will be rendered on the agent's screen. This can reference a Field or Variable, and the value will be inserted at Page load. For example, "http://www.example.com/users.aspx?id=[User ID]".
|
Tab Order
|
Specifies the order in which Fields on a Page will be focused if the agent presses the tab button on their keyboard. It will start at the lowest specified number and work up to the highest specified number, before then proceeding through any unspecified Fields from the top of the Page down. Note that if there are any Fields that share a tab order number, then they will be cycled through from the top of the Page downward.
|
Text
|
Most input-type Controls have a text label next to them to explain to the agent what the input, provide some narrative, or what they should enter; this label is set by this option. This can reference a Field or Variable, and the value will be inserted at Page load. For example, "Interest for [Loan Type]".
|
Validate Page
|
If enabled, then when the Field is triggered, all Fields on the Page that have a Validation option configured will have that Validation checked. Any Validation failures will prevent the initiating Field from continuing to its action, such as transitioning Page, executing stored JavaScript or SQL code, or sending an email. It will also cause any Fields that failed the Validation to be highlighted red until their failing condition is remedied.
|
Z Index
|
The Z Index specifies the layering of Floating Controls, controlling whether they appear in front of or behind other elements and Floating Controls on the Page.
|