Script Tabs

Basics

Getting Started

---

 Script Editor

Each Process tab includes a script editor which provides numerous functions that support the easy creation of scripts.

Highlighting Syntax Components

For a better distinction, the individual script parts are shown in different colors:

• green is used for comment lines
• blue for script statements
• red for script functions
• brown for JCL lines
• gray for strings
• purple for script variables

The script editor also highlights occurring script variables or script elements if the mouse pointer is positioned somewhere in the name.

Auto Completion

Use the shortcut CTRL + space bar for the code-completion function which completes the names of script functions and script statements. A list of possible script elements is displayed if there is more than one possible choice. Use the ESC key to close this list.

In addition to the list referred to above, the script editor displays the particular page of the Automation Engine Documentation which contains a description of the highlighted script element provided that the corresponding option has been activated in the settings of the UserInterface.

Include Objects

If Include objects are used in scripts, you can have their contents displayed. Do so clicking the plus signs in the tab's left edge. It is possible to edit the displayed Include object's scripting lines. Storing the script has the effect that modifications made in the Include object are also stored.

Note that this influences alle objects that use the changed Include object.

Users without read or write permissions for the relevant Include object cannot have its content displayed nor modify it. The script lines of the Include object are displayed in light gray and cannot be edited if a user has no write permission.

Note that in the script, the search function includes the content of Include objects if these have been expanded using the plus sign. Also, when exporting the script to a text file and when copying scripting lines Include objects include, only the contents of expanded Include objects are considered.

An Include object which has been included in a script several times can only be modified in the position where it has been expanded first. The script editor displays all other positions in light gray.

Line Prefix and Indentation

The script editor supports the quick and clear creation of scripts by assuming the current line's prefix to the subsequent line. It can also indent script lines in constructions such as :IF or :WHILE and close them with the corresponding closing statement (such as :ENDIF or :ENDWHILE). By default, each of these functions is activated (settings of the UserInterface).

Opening the Automation Engine Documentation

Highlight the name of a script function or script statement and press the F1 key. The Automation Engine Documentation opens exactly the page which contains the description of the relevant script element.

You can also position the mouse pointer somewhere within the name of a script function or script statement and then press the F1 key.

Popup-Menu Commands

The Process tab provides a range of functions which all provide support in the creation of scripts. Open the relevant functions via the UserInterface's toolbar or the context menu.

The following functions are provided in addition to standard commands such as undo, copy or cut:

• The search function does not only find strings but can also be used to replace the names of found strings.
• Several lines can be commented and uncommented at the same time.
• Scripts can be stored or imported to files.