Enhance help

The basic structure of an enhancement command for adding the help to runnables apg, umcadmin, adsadmin, octopus, and copernicus is as follows:

on <node name> enhance <instance ID> with help <help artifact> <version> type war

where:

<node name> is the logical name of the node, for example, n1.

<instance ID> is the instance ID of the runnable you want to add the help to, for example, octopus_m.

<help artifact> is the technical name of the actual set of help files, for example, com.aris.documentation.architect. The technical name can be different for the help of different runnables.

<version> is the version you are updating to, for example, 10.0.22.0.

For the abs runnable, some parts of the online help have been separated into dedicated files for different languages. The language can be specified with an additional option, the <classifier> in the enhance command. For adding help to the abs runnable, the structure of the enhance command is therefore:

on <node name> enhance <instance ID> with help <help artifact> <version> classifier <lang> type war

The placeholders <node name>, <instance ID>, <help artifact>, and <version> have the same meaning as described above.

<lang> is the language of the help artifact. Currently, there are abs help files for five different languages available: en (English), de (German), fr (French), es (Spanish), and ja (Japanese).

You can easily add all languages using multiple enhancement commands or just select the languages you need depending on your user base.

We recommend using the enhanceall command (see ACC help).