This statement is used to return a list of fields via the UI. The statement allows you to specify a single line prompt which is displayed above the list of available fields table. The prompt may contain any of the escape sequences described in Escape Sequences.
The statement is controlled by four named variables:
- Prompt for Fields Results
- This named variable contains a list of the fields selected by the user. The produced list uses the default list delimiter (\~).
- Prompt for Fields Exclusions
- Use of this named variable is optional. When it is not empty it contains a list of fields which are not to be displayed. Note that the Track Variable fields are never displayed. The list may be delimited by default list delimiters (\~), newline characters (\n) or commas. Note that if you select the fields at runtime using the all but selected items mode, the exceptions are applied on the results to ensure that they are never in the list.
- Prompt for Fields Initially Selected
- Use of this named variable is optional. When it is not empty it contains a list of fields which are initially selected. The list may be delimited by default list delimiters (\~), newline characters (\n) or commas.
- Prompt for Fields Constraints
- Certain constraints can be enforced on the user specified field selections. If the requirements are not met, the panel will not be closed. The constraints are specified in the named variable Prompt for Fields Constraints. Two constraints are currently supported:
- E (case insensitive)
- At least one effective field must be specified.
- 1
- One and one effective field must be specified.
Note that these constraints can also be set by clicking on the gear icon when defining the statement.
If you want to enter field names manually, remember that a field name can be entered via the context menu item Insert Yate Field while holding down the Shift key.
You can configure up to four buttons. See Configuring Buttons on Prompt Statements for more information.
The statement supports additional configurability which is documented in Advanced Prompt Statement Functionality. These settings can be configured by clicking on small button with the gear icon.
