User Guide > Objects > Alphabetical Listing > Documentation Tabs

Documentation Tabs

The Documentation tabs are userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management.-defined, clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type.-specific tabs, which can be assigned to all objects in the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes..

All Documentation tabs that the administrator entered in the UC_OBJECT_DOCU variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. are displayed. Regardless of this fact, imported objects have their own Documentation tabs.

Structured Documentation

Every tab can be displayed in a structured form. Using structured documentation, you can divide comprehensive information on an objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task into clear parts. Every node of the documentation offers the normal functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… to add text as well as the additional option to define attributes.

It is also possible to define links in structured documentation. These can be links to files or folders or links to documents on the intranet and Internet. In this way, files are displayed with the associated applicationAn application is a software which helps a user to fulfill specific tasks. In the context of ARA see also: Application entity., folders are opened, URLs call up the standard browser, etc. Here, the actions depend on the installed applications and the configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. of the user's PCs.

At first, a new Documentation tab only contains the 'Content' folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities.. This is the starting point from which you can establish the further structure. The following commands are available via the context menu for creating and editing it.

Command

Description

New attribute

Creates a new attribute in the highlighted node.

Add node after

Adds a new node after the highlighted node.

Add node before

Adds a new node before the highlighted node.

New sub-node

Adds a new node one level under the highlighted node.

Duplicate node

Duplicates the highlighted node with its attributes and content.

Delete node

Permanently deletes the highlighted node.

It is possible to create one or several attributes for each individual node. In principle, a distinction is made between two types: text and enumeration. You can add one or several of these attributes to a node. Specify the name of the attribute and then select whether it is a text or enumeration. In the second case, you can specify the items these should contain.

The XML naming convention must be taken into account when naming nodes and attributes. Letters, numbers, and the "-", ".", "_" symbols may be used. Note the following rules:

You can read structured documentation with special script elements (XML_*).

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH