objects can contain Documentation tabs. The type and number of these tabs can be defined per 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. and objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task type in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. "UC_OBJECT_DOCU."
Key |
Value |
New start required |
---|---|---|
Title of the documentation tabs Tabs of structured documentations are limited to 9 characters. |
No |
The variable is supplied with client 0000. It can be copied into your own client and customized to your requirements.
Individual documentation tabs can be specified for objects. Enter the object type's short form in the section key and your preferred tab title in the value. If the same setting should apply for all object types, enter "*" in the Key columnColumn in static Variable objects that can be used to access values of a particular line..
The system first checks whether a validity key has been specified in the particular object type's variable. If not, validity key "*" is used.
The name of a regular documentation tab must not exceed 10 characters and the name of a structured documentation is limited to 9 characters. If you define a longer name, an error message is displayed with the appropriate message and the name of the tab is truncated. The characters that are included in the Microsoft Windows Codepage 1252 (Latin I) can be used for the name.
You can also create more than one Documentation tab per object. In this case the corresponding names are written one after the other, and they are separated from each other by a comma. A structured documentation tab can be created by adding the additional character "@" in front of its name (for example, @tasks). All the Documentation tabs are displayed in the objects in the same order as has been specified in the variable.
The following characters can be used in the names of Documentation tab: A-Z a-z 0-9 . @ _
The @ character must only be used as the first character because it indicates that this is a structured Documentation tab. If you use characters that are not allowed, an error message is output when you open the object and the affected Documentation tabs are hidden.
Even if tabs are changed (renamed or deleted) in the variable, the existing tabs are still kept in the objects. Note that imported objects also keep their own Documentation tabs regardless of the variable's content. The tabs that are defined in UC_OBJECT_DOCU are displayed additionally.
The Version Management tab displays the saved versionsAn application version holds zero or more deployment packages and may have dependencies to zero or more application versions of the same (or to different) applications of the objects if this functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… has been activated in the variable UC_CLIENT_SETTINGS.
Key | Value |
---|---|
JSCH |
General,@Details |
If you import a Schedule objectIt starts executable objects periodically. A particular Automation Engine object type. that contains the Documentation tab "Contacts", the following tabs are shown afterwards: "General", "Details" and "Contacts."
See also:
Overview of all variables
in table form
Variable
Documentation Tabs
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |