Typographical Conventions

Names of buttons, fields, windows, text fields, symbols, (GUI) elements, columns, flags, login masks, entities and shortcuts appear in boldface type.

Italics are used for:

• Product names, program names
• Names of other documents, chapters, book titles
• Selecting enumerations (such as in combo boxes, radio buttons, checklists, checkboxes). Note that the names of these combo boxes, radio buttons etc. are written in boldface type.

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 folder 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).

Script statement and function names are written in bold text. Script statements begin with a colon.

Some script 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 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 task name or running number for the MODIFY_TASK script function.

MODIFY_TASK (RunID, [task name], [running number], REPLACE_TASK, object name, [EXTERNAL, workflow name])

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 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 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 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")

Warning, indicates possible problems.

Provides useful information, notes etc.

Steps that can only be performed by administrators.

Indicates a step. For example, an installation step.

Indicates peculiarities that are based on specifications of the authorization system (such as privileges and rights).