The following conventions are used in order to ensure a consistent appearance and to make the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. Documentation easy to read.
Example | Description |
---|---|
Option Login to:, Help button, Content tab |
Names of buttons, fields, windows, text fields, symbols, (GUI) elements, columns, flags, loginAn Automation Engine object type that stores account credentials used by agents on target systems. masks, entities and shortcuts appear in boldface type. |
Automation Engine help; for more details, see the Getting Started chapter. |
Italics are used for:
|
UC.MDB, Table USR, UCXJR3?.INI | In descriptive texts, directories, signatures, folders, file names, programs or tables in the AE databaseA database is an organized collection of data including relevant data structures. are written in uppercase letters. The "?" character is used as a wildcard within file names. |
IMAGE:TOOLS\BS2_TAR |
In descriptive texts, folders on the AE CDROM are written in the form IMAGE:FOLDER and are capitalized. IMAGE: is a placeholder for the letter of the CDROM drive and also the folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. name that corresponds to the version number of AE. Example: IMAGE:TOOLS\BROWSER corresponds to R:\11.0.0\TOOLS\BS2_TAR |
<system>AE</system> |
With this formatting being used, file abstracts are flagged (such as reports or configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. files). |
Special conventions also apply for the description of AE's scripting language. These conventions are used in combination with the general conventions whenever the scripting language is explained within the Automation Engine documentation:
Syntax for | Description |
---|---|
Script statement and functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… names |
Script statement and function names are written in bold text. Script statements begin with a colon. Some scriptA particular Automation Engine object type. statements and functions can be written in long or short forms. When that is the case, the script statement or function is documented with the optional text for its long name in [ ] brackets. For example, the script statement :PRINT is documented as :P[RINT]. It can be written as :PRINT or :P, depending on your preference. |
Required parameters |
Required parameters are written in bold dark red italics. For example, Object name. In some cases one or more of a subset of parameters are required. In this case, the parameters are written in bold dark red italics and enclosed in [ ] brackets. For example, you must define the taskAn executable object that is running. Tasks are also referred to as activities. name or running number for the MODIFY_TASK script function. MODIFY_TASK (RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component ., [task name], [running number], REPLACE_TASK, objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task name, [EXTERNAL, 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."] name]) |
Required special characters |
Required special characters such as open and close parentheses or equal signs are written in bold dark red italics. In the example below, = is a required qualifier between the required parameters Property and Value. :MODIFY_STATEProperty=Value |
Optional parameters |
Optional parameters are written in [ ] brackets and italicized; for example, [Date]. In some cases when multiple optional parameters are used together, they may be enclosed together in the same set of [ ] brackets; for example [Calendar, Calendar Keyword]. |
Keyword parameters |
Keyword parameters are written in bold; for example, VERSION. When they are optional, keyword parameters are also enclosed in [ ] brackets; for example, [TERMINATE]. The text for keyword parameters must be written exactly as specified. Some keyword parameters can be written in long or short forms. In this case, the keyword parameter is documented with the optional text for its long name in [ ] brackets. For example, the keyword parameter STR_SUBSTITUTE_VAR is documented as STR_SUB[STITUTE]_VAR. It can be written as STR_SUBSTITUTE_VAR or STR_SUB_VAR, depending on your preference. |
Commas |
Commas separate script element parameters. Script elements are evaluated in the order they are listed. In the example showing syntax below, commas separate the each of the CREATE_OBJECT script function's parameters. CREATE_OBJECT(Object Type, Object Name, [Folder], [Title]) When you don't want to specify a value for an optional parameter, you put nothing (or a space) between the commas. For example, to not specify a folder, you put nothing between the third and fourth commas as shown below. :SET&RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015",,"Firm calendar for 2015") If you've specified values for all required parameters, and you don't want to include values for any remaining optional parameters, you don't need to include commas for the remaining optional parameters. For example, if you want to create an object without specifying a folder or title, you could place the closing parenthesis after the object name parameter as shown below. :SET &RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015") |
Spaces | Spaces in scripts are sometimes required. When they are required, they are included in the syntax. Additionally, spaces that are not required are sometimes included in the documented syntax for readability. You can add these and other optional spaces in your scripts for readability or preference. |
The following symbols are available:
Symbol | Description |
---|---|
|
Warning, indicates possible problems. |
![]() |
Critical warning (system crash, DB inconsistency) |
|
Provides useful information, notes etc. |
|
Steps that can only be performed by administrators. |
|
Indicates a step. For example, an installation step. |
![]() |
Incompatibility |
|
Indicates peculiarities that are based on specifications of the authorization system (such as privilegesPrivileges in the Automation Engine refer to user rights to work with certain frontend and user interface functions. You grant privileges to users in the Automation Engine. and rights). |
![]() |
Tips for easier handling or better performance. |
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |