Using the Product Documentation

A new documentation set is provided with each major version of your product. When you download it for installation, the documentation comes with it. However, the documentation team works continuously to update and improve it. 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.

Scope and Target Groups

The following guides and reference documents are available:

• Release Highlights

  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

  This guide provides the following:

  • Logging in and out information
  • Overview of the UI
  • Descriptions of how to define session and user settings
  • Description of basic functions that help you optimize your daily work

• Using

  Addressing mainly (but not only) developers, object designers and operators, this guide describes functions and provides examples that illustrate them. You also find and step-by-step instructions here.

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

• Administering

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

• Installing

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

• Integrating

  This guide provides guidelines for integrating CA Continuous Delivery 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.

• Scripting Guide

  This comprehensive guide addresses mainly developers and object designers. It describes the Automation Engine scripting language and provides lists of all available script elements with their descriptions as well as many useful examples.

Accessing the Online Help

You can access the product Online Help as follows:

• From within the software, see Context-Sensitive Help.

• At docs.automic.com

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 left 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.

Context-Sensitive Help

Help with a Perspective or a Page in a Perspective

Every page and sub page provides direct access to the topic in the product documentation that deals with it. Expand the dropdown list on the upper right corner of the screen and select Online Help to open the topic that describes the object, task, perspective, etc. that is currently active.

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 on any of the Process pages of the object definition. For more information, see Working with the Script Editor.

Printing a Topic

All guides are available as online help only. To print a topic, click the printer icon on the help toolbar.

Expanding Collapsible Sections

Some topics contain a lot of information, which is usually divided in sections you can easily recognize. In such cases, some sections can be collapsed to help you have an overview of the topic content without having to scroll through it.

You have two options to have the collapsed content displayed:

• Click the collapse all button at the top of the topic to expand ALL collapsed sections on a page:
• Click the arrow next to the text to expand only that section.

See also:

• Troubleshooting

  • I Cannot Open the Online Help
  • The Online Help Renders No Results