ADD-DOCUMENTATION mask - Add documentation lines

Mask sequence

MENU

-> 9 ->

ADD-DOCUMENTATION

Function

This mask allows message units to be documented. The documentation is assigned to the message units via message codes (e.g. AAA0001) or via a message range (e.g. AAA0002-AAA0015).

The following specifications are possible:

• Message code/message range

• Name of person responsible for these messages (20 characters)

• Name of the team responsible for these messages (15 characters)

• Comment (60 characters)

The message codes can be entered in the mask in any order. If they are confirmed with DUE, the codes are sorted alphabetically and the documentation lines are stored in the message file.

In this mask, by contrast with MODIFY-DOCUMENTATION, the documentation lines must be appended to already existing ones. The latter being overwrite-protected.

The specified message codes and the contents of the documentation lines are not checked for errors.

If an already documented message range is input, MSGMAKER outputs the following message:

MSMQL00 DOCUMENTATION LINE '<message range>' ALREADY EXISTS
(COMMENT='<comment>'). OVERWRITE? REPLY (Y=YES; N=NO)? N

If the user responds with N, the documentation line is displayed again and can be modified.

Using the COPY or MOVE function, documentation lines can be copied or moved within a message file or between two files.
The SHOW function can be used to output to SYSOUT or SYSLST.

Mask

Output fields

Message file

The current message file is displayed. It was opened in the MENU mask. The file name cannot be modified in the ADD-DOCUMENTATION mask.

If documentation lines have already been written for this message file, the last message range, alphabetically speaking, is displayed in the first line of the documentation area. The cursor is located at the beginning of the next line.
The “-” character (in the command line) can be used to page back to message ranges that have already been documented.

Input fields

Msg-id, interval (message code/message range)

This field is used to input a message code or message range which is documented in the subsequent fields. When the input is confirmed with DUE, a single message code is repeated as the upper range limit (e.g. AAA0001-AAA0001).

Validity criteria:
Seven-character message code, of which the first three characters must be letters (message class). The limit values for a message range must belong to the same message class.

The tab key can be used to jump to the next field.

 

Comment (comment on the messages)

Validity criteria:
Maximum 60 characters, including spaces.

The tab key can be used to jump to the next field.

Owner (person responsible for these messages)

Validity criteria:
Maximum 20 characters, including spaces.

The tab key can be used to jump to the next field.

Owner team (team responsible for these messages)

Validity criteria:
Maximum 15 characters, including spaces.

The tab key can be used to jump to the next field.

Command

For detailed information on

• entering statements, see "General mask format"

• function key assignment, see "General mask format"

Follow-on operations:

ADD-DOCUMENTATION

-> ?

DUE	The inputs are confirmed and the routine returns to the MENU mask.
K1	The ADD-DOCUMENTATION function is aborted. The inputs are lost, even if the user previously paged to another ADD-DOCUMENTATION mask with “+” and then pressed DUE.