UC_OBJECT_DOCU - Object Documentation

Objects can contain Documentation pages. The type and number of these tabs can be defined per client and object type in the variable "UC_OBJECT_DOCU."

Description

The variable is supplied with client 0000. It can be copied into your own client and customized to your requirements.

Individual documentation pages 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 column.

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 page 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 page 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 page 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 pages 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 pages: 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 page. If you use characters that are not allowed, an error message is output when you open the object and the affected Documentation pages are hidden.

Even if tabs are changed (renamed or deleted) in the variable, the existing pages are still kept in the objects. Note that imported objects also keep their own Documentation pages regardless of the variable's content. The pages that are defined in UC_OBJECT_DOCU are displayed additionally.

The Version Management page displays the saved versions of the objects if this function has been activated in the variable UC_CLIENT_SETTINGS.

Example

If you import a ScheduleStartet in periodischen Abständen aktivierbare Objekte. Auch ein eigener Objekttyp in der Automation Engine. object that contains the Documentation page "Contacts", the following pages are shown afterwards: "General", "Details" and "Contacts."

See also:

Overview of all variables in table form
Documentation Pages