This Variable (VARA) object defines the type and number of documentation pages per client and object type. It is supplied with system client 0 and can be copied to other clients and customized as needed.
-
Key:* or Short name of the object type
-
Value:Title of the documentation pages
Each page label, whether structured or unstructured ,is limited to 10 characters.
-
Restart required: No
Individual documentation pages can be specified for objects. Enter the short form of the object type in the Key column and your preferred page label in the Value column. Enter * in the Key column to apply the same settings to all object types. The system checks first whether a key has been specified in the particular object type's variable. If not, key * is used.
Each page, whether structured or unstructured, is limited to 10 characters. If you define a longer name, an error message is displayed and the name of the page is truncated. The characters that are included in the Microsoft Windows Codepage 1252 (Latin I) can be used to define the name of the page.
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 page can be created by adding the additional character @ in front of its name. For example, @tasks. All the documentation pages are displayed in the order in which they have been specified in the variable.
The following characters can be used in the names of a documentation page: A-Z a-z 0-9 ._
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 pages 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 UC_CLIENT_SETTINGS variable. For more information, see Version Management Page.
Example
-
Key: JSCH
Value: General,@Details
If you import, for example, a Schedule object that contains the documentation page Contacts, the pages displayed are General, Details and Contacts.
See also: