:BEGINREAD... :ENDREAD
Use the :BEGINREAD and :ENDREAD script statements to define a user dialog block. These statements enclose one or more :READ or :PRINT statements, allowing you to create custom dialogs that prompt users for input or display instructional text during script execution.
The number of :READ statements dictates the overall size of the dialog, while their specific parameters control the appearance and functionality of the input fields. Use :PRINT statements to provide clear instructions or contextual information within the dialog window.
Notes:
- You can include any number of :READ and :PRINT statements within the :BEGINREAD...:ENDREAD block.
- Message text (such as in :READ or :PRINT statements) is limited to 256 single-byte characters. If you use multi-byte characters, the character limit is proportionally lower. To display longer messages, split your text across multiple :PRINT statements.
- Executing this script statement forces all open script transactions to be immediately written to the AE database.
Important! The dialog is not displayed if the task—or the Workflow containing the task—is configured to generate at runtime. In this scenario, the script automatically applies the default values defined in the :READ statements. If these default values result in invalid responses, the system cancels the script generation.
More Information:
- Script Processing
- Executing Objects: Generating Task at Activation Time vs Generating Task at Runtime
Syntax
:BEGINREAD [Label[,F]]
Statements
:ENDREAD
Parameters
| Parameter | Description | Allowed Values |
|---|---|---|
| Label |
(Optional) Name of the dialog. Format: script literal, script variable or script function Default value: name of the object |
n.a. |
| F |
(Optional) Formats the text in the dialog so that all letters are the same width. Tip: This parameter is helpful for aligning columns. |
n.a. |
| Statements |
Script statements that define the contents of the dialog. |
n.a. |
Examples
The following example creates a dialog titled Log on, which requests the user to enter their department and name:
:BEGINREAD "Log on"
:READ &DEP#, "08", "Please enter your department",, M
:READ &NAME#, "08", "Please enter your name",, M
:ENDREAD
See Also