Documentation Tips and Tricks

Tips and Tricks on Using the Automation Engine Documentation

The following list is designed to help you find your way through the comprehensive Automation Engine documentation.

	Structure of the Automation Engine Documentation

The Automation Engine documentation consists of the following main chapters:

Name	Content
Welcome	The contact addresses and general information about help formats.
User Guide	Detailed descriptions about using the program interface AE Script.
Automation Engine Script Guide	The syntax of the script elements.
Administration Guide	Information about administering AE systems.
Inside AE Guide	Background information about the internal processes of AE.
Sample Collection	Scripting examples that show how objects and script elements can be used together.
Best Practices Guide	The guidelines for handling AE.
Application Integration Guide	The descriptions of components that can be used to monitor and control processing in AE from external applications,
KnowledgeBase	General information about AE and all supported platforms,
Release Notes	The Release Notes of the individual Automation Engine versions,

	Opening the Automation Engine Documentation

F1 key
You can open the Automation Engine documentation from every location within the UserInterface by using the F1 key. A document will open that describes exactly the particular window, tab or script element, you pressed F1 in. You can also open the Automation Engine documentation in the Process tabs.
Just highlight the name of the script element (for example, PRINT) or position the mouse pointer somewhere in its name.
The F1 key opens exactly the page that describes the particular script element.

Manually
You can also manually open the Automation Engine documentation from the folder in which it is stored:

WebHelp: help.htm

	Searching in WebHelp

Select the menu item "Search" in the navigation bar on the left in order to search through the complete documentation. All chapters that include the searched term are listed. They are sorted according to the frequency of their occurrence per document.
In the particular documents that the list includes, the searched term is highlighted in yellow.
The following search rules apply:
- Uppercase and lowercase letters are not distinguished.
- Wildcards (such as * or ?) are not supported.
- To search for an expression like Automation Engine Scripts, use inverted commas: "Automation Engine Scripts"
- You can use any combination of letters (a-z) and numbers (0-9).
- The system searches for whole words. Punctuation marks at the beginning and the end of a term are ignored.
- You can also search for several words. The following combinations are allowed: AND relations (separator: &), OR relations (blank or | can be used as a separator) and negations (! character in front of the term).

	Using Bookmarks (WebHelp)

WebHelp: In WebHelp, you can add pages in the form of bookmarks (small star in the upper WebHelp bar). Bookmarks are always available in the left bar of the menu item "Bookmark". You can also use the "Favorites" of the Web browser.
Bookmarks and favorites for the documentation are stored in a particular location on the computer. If you move the help to a different directory, these bookmarks and favorites are no longer available.