MODIFY-DOCUMENTATION - Modify and delete documentation lines

Function

The //MODIFY-DOCUMENTATION statement is used to process documented messages in the following ways:

• Modify documentation lines

• Delete documentation options (only the variable options are deleted)

The documented messages are selected using the message code.

Differences compared with the //MODIFY-DOCUMENTATION statement in menu mode

The //MODIFY-DOCUMENTATION statement which can be entered in the command area of the screen mask differs from the //MODIFY-DOCUMENTATION statement in command procedures in that in menu mode, the operand value *PANEL-REQUEST can be assigned to any operand.

For further details, see section “Special features of statements in menu mode”.

Format

MODIFY-DOCUMENTATION                                                                                                                           

MSG-ID = *INTERVAL(...) / <name 7..7>
	*INTERVAL(...)
		|	FROM = <name 7..7>
		|	,TO = <name 7..7>
,OWNER = *UNCHANGED / *NONE / *PARAMETERS(...)
	*PARAMETERS(...)
		|	NAME = *UNCHANGED / *NONE / <c-string 1..20>
		|	,TEAM = *UNCHANGED / *NONE / <c-string 1..15>
,COMMENTS = *UNCHANGED / *NONE / <c-string 1..60>

Operands

MSG-ID = *INTERVAL(...) / <name 7..7>
Designates one or more message units which are to be modified.

MSG-ID = <name 7..7>
The full message code, consisting of the three-character message class and the four-digit message number, must be entered.

MSG-ID = *INTERVAL(...)
Designates a message range. The limit values of the range must belong to the same message class.

FROM = <name 7..7>
Designates the lower limit value of the message range (full message code).

TO = <name 7..7>
Designates the upper limit value of the message range (full message code).

 

OWNER = *UNCHANGED / *NONE / *PARAMETERS(...)
Designates the persons responsible for the message file.

OWNER = *UNCHANGED
The specifications regarding the persons responsible will not be changed.

OWNER = *NONE
No specifications are made regarding the persons responsible. Existing specifications are deleted.

OWNER = *PARAMETERS(...)

NAME = *UNCHANGED / *NONE / <c-string 1..20>
Designates the person responsible for the message file.

NAME = *UNCHANGED
The specifications regarding this person will not be changed.

NAME = *NONE
The specifications regarding this person will be deleted.

NAME = <c-string 1..20>
The specifications regarding this person will be modified.

TEAM = *UNCHANGED / *NONE / <c-string 1..15>
Designates the team responsible for the message file.

TEAM = *UNCHANGED
The specifications regarding the team will not be modified.

TEAM = *NONE
The specifications regarding the team will be deleted.

TEAM = <c-string 1..15>
The specifications regarding the team will be modified.

COMMENTS = *UNCHANGED / *NONE / <c-string 1..60>
Designates the comment for the selected messages.

COMMENTS = *UNCHANGED
The comment will not be changed.

COMMENTS = *NONE
The comment will be deleted.

COMMENTS = <c-string 1..60>
The comment will be modified.

 

Example

The message ranges (AAA0001-AAA0010) and (AAA0021-AAA0030) are documented as follows:

//ADD-DOCUMENTATION -
   MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0010),-
   OWNER=*PARAMETERS(NAME='John Miller',TEAM='ABC 0001'),-
   COMMENTS='messages for test product'
//ADD-DOCUMENTATION -
   MSG-ID=*INTERVAL(FROM=AAA0021,TO=AAA0030),-
   OWNER=*PARAMETERS(TEAM='ABC')

Output to SYSOUT or SYSLST:

The documentation is to be modified:

• AAA0001-AAA0010: Name to be modified to Harry Miller; Comment to be modified to “device errors”

• AAA0021-AAA0030: Specification regarding team to be deleted

//MODIFY-DOCUMENTATION -
   MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0010),-
   OWNER=*PARAMETERS(NAME='Harry Miller',TEAM=*UNCHANGED),-
   COMMENTS='device errors'
//MODIFY-DOCUMENTATION -
   MSG-ID=*INTERVAL(FROM=AAA0021,TO=AAA0030),-
   OWNER=*PARAMETERS(TEAM=*NONE)

Output to SYSOUT or SYSLST: