Field help documentation

Creating field help

The function for field documentation is GESADZ. You can access this function from two locations:

  1. From the documentation menu:

    1. Go to Development > Data and parameters > Documentation > Field documentation.

  1. From a function:

    1. Go to Development > Data and parameters > Documentation > Documentation.

    2. In the Screen field, click the Actions icon then click Help key-word entry.

    3. In the Help key-word field of one key-word (field), click the Actions icon then click Jump to. You are redirected to the Field documentation function (GESADZ).

To create new field help:

  1. Enter the Language, the Key word, and the Module.

  2. Tabulate, enter your text in the Help text block then click Create.

To modify existing field help, modify the content then click Save.

General field help and linked field help

General field help

General field help is field help that can be reused with other field help. It can be linked to other field help. Advantages are cost savings for translation as the same content does not have to be rewritten multiple times.

You can define a field help as general (field) help, as follows:

  1. Select the General help check box in the Field documentation function (GESADZ).

  2. Click Save.

To change a general field help to standard field help, clear the General help check box then click Save.

To view the list of general help, use the AIDEGENE query, in Setup > Usage > Reports > Query tool. To view a list of screens in which the selected general help can be found, you can either:
  • Use the GENECRAN query.
  • Use the Where-used action directly from the field documentation function.
A field help is defined as general help so that it can be referenced and linked to another field help. Do not define it as general for the sole purpose of using it as the target of a hyperlink from another help.

Linked field help

Linked field help can be linked to a standard field help.

Select the General help check box. The help becomes a linked help.

How to link a general help to a standard help

  1. Open the standard field help to be linked with a general help.

  2. In the Linked help field, enter the general help keyword to link.

  3. Select the Before radio button or the After radio button to specify if the general help text must be displayed before or after the standard field help text.

  4. Tabulate then click Save.

Only the text that is specific to the standard field help is displayed in this window. The text of the linked help displays in the final HTM page.