4 8 Process Help Text

You are here:

4.8 Process Help Text

HELP text is information that is displayed to the user when the HELP key is used.

Generally HELP text has these characteristics:

It is free format. No restrictions usually exist on the content or format of HELP text.

It relates directly to the action the user was taking at the time the HELP key was pressed. Usually the process or function that the user is using is explained in some detail.

Quite often the fields on the screen that was on display when the HELP key was pressed are each described in detail. Part of the description usually involves the name and description of the field, any validation rules that apply to its input and comments on the use and interpretation of the field's value.

LANSA automatically controls the handling of the HELP key. In addition LANSA will automatically determine the type of HELP that is required (field, process or function) and automatically display the associated HELP text (if any exists).

LANSA can dynamically, and in the correct language, create the HELP text associated with a field from the dictionary and the rules that it contains. You can turn off this automatic field level help text feature: globally, by field, or precede it with your own HELP text.

What LANSA cannot do is create the free format HELP text that is associated with the processes or functions. This is generally the task of the person who creates the process or function.

Once the HELP text has been entered, LANSA will automatically display it at the appropriate time.

The actual method used by LANSA to display HELP text is described in some detail in the Messages and the Help Key.

Refer to Field Help Text for information about how field HELP text is entered.

The steps involved in the review, change or creation of the HELP text associated with a process or function are as follows:

__________

1. Select the option to review, | |

change or create process or | PROCESS |

function HELP text on the | CONTROL |

process control menu. | MENU |

|__________|

____|_____

2. Select the process(s) for | |