Using the Documentation

A new documentation set is provided with each major version of your product. When you download the product for installation, the documentation is included. The documentation team works continuously to update and improve the help. You can always find the latest version of the documentation at https://downloads.automic.com/. If your company is using the documentation offline, we recommend that your system administrator visit this link regularly to download the newest version.

This page includes the following:

Scope and Target Groups

The following topics and guides are available:

  • What's New Automic Automation v24

    Summary of the new features in a version of the software and links to the topics in the documentation that deal with them.

  • Getting Started with Automic Automation

    Read these topics to get acquainted with the UI and to learn about useful functions that make your work more comfortable. The Getting Started section also provides topics that describe the first steps for all user roles.

  • Using Automic Automation

    Addressing mainly (but not only) developers, object designers and operators, this guide describes functions and provides examples that illustrate them.

    It also contains all you need to know about the Automation Engine scripting language.

  • Administering and Configuring

    Meant for system administrators, this guide contains information about user and authorization management, security, configuration and house-keeping activities.

  • Installing Automic Automation

    Also meant for system administrators, this guide contains guidelines for planning, installing and updating the solution and all its components.

  • Integrating in Automic Automation

    This guide provides guidelines for integrating Automic Automation with third-party systems.

  • Reference

    Here you can find many useful reference lists, such as INI file configuration, predefined variable and VARA object settings, API parameters, descriptions and examples of script elements and many more.

Accessing the Online Help

You can access the online product documentation on the product documentation website:

docs.automic.com

Context-Sensitive Help

You can also access the online help from within the software itself by clicking the ? button and selecting Help.

Help with a Perspective or a Page in a Perspective

Every view in the Automic Web Interface provides direct access to the topic in the product documentation that deals with it.

Click the ? button on the menu bar and select Help. The online help opens in a new browser tab and the relevant topic is displayed.

Help with Script Elements

When using the Automation Engine scripting language, you can access the topics that describe its elements and functions directly from within the script editor. For more information, see Context-Sensitive Help for Script .

Searching for Information

  • Using the Search field

    You find the Search field on the upper right corner of the online help.

    Use this method if you want to search for a topic without bothering about where it is located in the documentation. Type one or more terms related to it and press Enter.

    The list of results displays the first ten hits. If there are more, you can scroll back and forth using the Previous and Next buttons at the bottom of the list.

  • Using the table of contents

    Use this method if you are already familiar with the structure of the documentation or if you want to get acquainted with it. The table of contents is the pane on the right hand side that provides a tree structure that you can expand and collapse to access the topics.

    Use the arrows on the right corner of the help toolbar to navigate back and forth in the tree structure.

Printing a Topic

The product documentation is available as online help only. To print a topic, click the printer icon on the help toolbar.

See also: