Automation Engine Script Guide > Ordered by Function > Activate Objects > :BEGINREAD... :ENDREAD

:BEGINREAD... :ENDREAD

Script Statements: They are used to define the beginning and end of a dialog box for userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. queries.

Syntax

:BEGINREAD[Label], [F]
:ENDREAD

Syntax

Description/Format

:BEGINREAD

Beginning of the dialog box for user queries.

Label

Name of the dialog box.
Format: script literal, script variable or script function
Default value: name of the objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task

F

Formats the text in the dialog box so that all letters are the same width.

:ENDREAD

End of the dialog box for user queries.

Comments

The scriptA particular Automation Engine object type. statements :BEGINREAD and :ENDREAD define the beginning and the end of a dialog box for user queries. You can put any number of :READ statements between those two commands, the number of which determines the size of the dialog box. Their parameters are relevant for the appearance of the dialog box and the functions of the created input fields.

Specifying a name for the dialog is optional. The object name is used if it is not specified. If the parameter "F" is used, all letters show the same width which is helpful for exact alignment of columns.

Use the :PRINT statement, to write text to the dialog box.

The script statement causes all open transactions of the script to be written to the AE databaseA database is an organized collection of data including relevant data structures..

Generate at Runtime

The dialog box is not displayed if the option "Generate at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start)." (Attributes tab) is activate. The same is true if the object runs in a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."] that uses this setting.

Default values are used for :READ statements. If this does not result in a valid response, generation of the script is canceled.

Example

In the example, a dialog box named "Log on" is created. It requests the user to enter his departmentDepartment name to which the Automation Engine user belongs. and name.

:BEGINREAD "Log on"
:
READ &DEP#, "08", "Please enter your Department",, M
:
READ &NAME#, "08", "Please enter your Name",, M
:
ENDREAD

 

See also:

Script element Description

:READ

Queries the user in a dialog.
:PRINT This is used to write a text to a dialog for user queries or to the activation reportA report provides more detailed information about a task's execution or a component. of an object.

Script Elements - Activate Objects

Sample Collection:
Database Maintenance with Options

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH