Function
The //MODIFY-MSG statement modifies a message unit of the message file that is currently open. One or more message units can be accessed by specifying a message code or a message range. In addition to the message attributes, it is possible to modify message, meaning and response texts, inserts and insert attributes. This statement allows the user not only to modify existing operand values but also to assign new values to the operands or to delete operand values.
Differences compared with the //MODIFY-MSG statement in menu mode
The //MODIFY-MSG statement that can be entered in the command area of the screen mask differs from the //MODIFY-MSG statement in command procedures in that
in menu mode, the operand value *PANEL-REQUEST can be assigned to any operand.
an additional value can be specified for the MSG-ID operand
an additional value can be specified for the LANGUAGES operand
For further details, see section “Special features of statements in menu mode”.
Format
MODIFY-MSG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
Operands
MSG-ID = *CLASS(...) / *INTERVAL(...) / list-poss(2000): <name 7..7>
Specifies the message codes of one or more message units of the open message file that are to be modified.
MSG-ID = *CLASS(...)
All message units whose message code begins with the specified message class can be modified.
MSG-CLASS = <name 3..3>
Specifies the 3-letter message class.
MSG-ID = *INTERVAL(...)
All message units within this message range are modified.
FROM = <name 7..7>
Specifies the first message code of the message range.
TO = <name 7..7>
Specifies the last message code of the message range.
MSG-ID = list-poss(2000): <name 7..7>
Specifies the full message code of a message unit that is to be modified. A list of message codes may be specified.
ACCESS-METHODS = *UNCHANGED / list-poss(4): *ISAM / *DLAM / *LOCAL-DLAM / *MINIMIP / *BAMR
A new MIP message access method can be specified. Any declarations that were specified previously are deleted when the access method is modified.
ACCESS-METHODS = *UNCHANGED
The access methods remain unchanged.
ACCESS-METHODS = *ISAM
MIP searches for messages via the ISAM key.
ACCESS-METHODS = *DLAM<
The DLAM access method is used for particularly frequent messages. If a message file containing a DLAM message is activated, the DLAM message is loaded into main memory. MIP can output the DLAM message directly without accessing the message file.
ACCESS-METHODS = *LOCAL-DLAM / *MINIMIP / *BAMR
These access methods are reserved for internal use with the manufacturer.
This operand allows the message creator to document new, possible output destinations for the message. This specification is used for documentation purposes only. The output destination proper is determined in the DEST (destination code) operand of the MSG7X macro.
DESTINATIONS = *UNCHANGED(...)
The message output destination remains unchanged.
ROUTING-CODE = *UNCHANGED / <alphanum-name 1..1> / *MAIN-CONSOLE / *CONSLOG
The one-character routing code is evaluated as a destination specification for console outputs. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *UNCHANGED
The routing code remains unchanged.
ROUTING-CODE = <alphanum-name 1..1>
Any letter, digit or one of the special characters #, $ and @ can be specified as the routing code. The asterisk * must not be used. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *MAIN-CONSOLE
The message’s destination is the special routing code *, which is always allocated to the main console at least.
ROUTING-CODE = *CONSLOG
Messages that do not require a response are only logged in the CONSLOG file. ROUTING-CODE = *CONSLOG has the same effect as ROUTING-CODE = @.
DESTINATIONS = *ALL(...)
Messages may be output to any destination.
ROUTING-CODE = *UNCHANGED / <alphanum-name 1..1> / *MAIN-CONSOLE / *CONSLOG
The one-character routing code is evaluated as a destination specification for console outputs. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *UNCHANGED<
The routing code remains unchanged.
ROUTING-CODE = <alphanum-name 1..1>
Any letter, digit or one of the special characters #, $ and @ can be specified as the routing code. The asterisk * must not be used. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *MAIN-CONSOLE
The message’s destination is the special routing code *, which is always allocated to the main console at least.
ROUTING-CODE = *CONSLOG
Messages that do not require a response are only logged in the CONSLOG file. ROUTING-CODE = *CONSLOG has the same effect as ROUTING-CODE = @.
DESTINATIONS = *USER-TASK
The new message output destination is SYSOUT, SYSLST or a user-specific memory area.
The message output destination is a console. If *CONSOLE is specified as the new operand value, a routing code must be defined. If *CONSOLE is replaced by other output destinations, the associated routing code is suppressed automatically.
ROUTING-CODE = *UNCHANGED / <alphanum-name 1..1> / *MAIN-CONSOLE / *CONSLOG
The one-character routing code is evaluated as a destination specification for console outputs. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *UNCHANGED
The routing code remains unchanged.
ROUTING-CODE = <alphanum-name 1..1>
Any letter, digit or one of the special characters #, $ and @ can be specified as the routing code. The asterisk * must not be used. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
ROUTING-CODE = *MAIN-CONSOLE
The message’s destination is the special routing code *, which is always allocated to the main console at least.
ROUTING-CODE = *CONSLOG
Messages that do not require a response are only logged in the CONSLOG file. ROUTING-CODE = *CONSLOG has the same effect as ROUTING-CODE = @.
WEIGHT = *UNCHANGED / *NONE / <integer 0..99><
The weight code specifies the priority of a message. A weight must be specified for messages whose output destination is a console (DESTINATION = *CONSOLE(...)/*ALL was specified). Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
WEIGHT = *UNCHANGED
The weight code remains unchanged.
WEIGHT = *NONE
The message is not assigned a weight.
WEIGHT = <integer 0..99>
The message is assigned a value between 0 and 99. 99 represents the highest priority for a message.
WARRANTY = *UNCHANGED / *NO / *YES
The message attribute “Warranty” is evaluated by MIP.
The following message components are guaranteed:
message code
numbering and meaning of inserts
The message text is not guaranteed.
MIP creates S variables for warranty messages. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
Specifies the format of the message text when output to SYSOUT, a SYSLST file, a console or a user-specific memory area via the MSG7X macro or the /HELP-MSG-INFORMATION command. The default texts for inserts and the texts that are specified via the MSG7X macro are likewise adapted to this format.
MSG-TEXT-OUTPUT = *UNCHANGED
The format of the message text remains unchanged.
MSG-TEXT-OUTPUT = *UPPER-CASE
The message text entered is output in uppercase letters.
MSG-TEXT-OUTPUT = *LOWER-CASE
The message text is output exactly as it is entered in the operand LANGUAGES = ...(MSG-TEXT = '...').
LANGUAGES = *UNCHANGED / list-poss(8): <name 1..1>(...)
Specifies language identifiers for languages that are already defined. The user can modify message, meaning and response texts in these languages.
LANGUAGES = *UNCHANGED
No language identifiers are specified; the message, meaning and response texts are not to be modified.
LANGUAGES = list-poss(8): <name 1..1>(...)
The message, meaning and response texts in the languages represented by these identifiers are to be modified.
MSG-TEXT = *UNCHANGED / <c-string 1..220 with-low>
Specifies the message text that was written in the specified language.
MSG-TEXT = *UNCHANGED
The message text remains unchanged.
MSG-TEXT = <c-string 1..220 with-low>
Defines a new message text for the specified language.
MEANING = *UNCHANGED / list-poss: *ADD(...) / *INSERT(...) / *REPLACE(...) / *REMOVE(...)
Specifies the meaning text written in the specified language that will be displayed via the /HELP-MSG-INFORMATION command. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
Each line of the meaning text (up to 256 lines) can be modified or deleted. In addition, new lines can be appended or inserted. The lines of the meaning text are numbered internally from 1 through to a maximum of 256 and can be addressed individually via these numbers.
MEANING = *UNCHANGED
The meaning text remains unchanged.
MEANING = *ADD(...)
One or more new lines can be appended to the meaning text.
TEXT = list-poss: <c-string 1..74 with-low>
Meaning text consisting of one or more lines that is to be appended to the existing text.
MEANING = *INSERT(...)
One or more new lines can be inserted into the meaning text. Once all changes have been made, all the subsequent lines are renumbered.
LINE-NUMBER = <integer 1..256>
The new text is inserted between the line number specified here and the previous line number.
TEXT = list-poss: <c-string 1..74 with-low>
Specifies the new meaning text.
MEANING = *REPLACE(...)
The meaning text in the specified line is replaced by the new text entered.
LINE-NUMBER = <integer 1..256>
Specifies the number of the line containing text to be replaced.
TEXT = <c-string 1..74 with-low>
Specifies the text that is to replace the meaning text in the specified line.
MEANING = *REMOVE(...)
Lines can be deleted from the meaning text. Once all changes have been made, all subsequent lines are displaced and renumbered.
LINE-NUMBERS = *ALL / list-poss: <integer 1..256>
Specifies the line numbers.
Examples for the MEANING operand
Meaning text:
Line 1: 'texttext 1'
Line 2: 'texttext 2'
Line 3: 'texttext 3'
Example 1
This example inserts a new line into the meaning text given above, replaces one line of text with another and appends a line to the meaning text.
MEANING=(*INSERT(2,'texttext 1 ext'),*REPLACE(2,'texttext 2 new'),
*ADD('texttext 4')
Meaning text with renumbered lines:
Line 1: 'texttext 1'
Line 2: 'texttext 1 ext'
Line 3: 'texttext 2 new'
Line 4: 'texttext 3'
Line 5: 'texttext 4'
Example 2
This example deletes the first line of the original meaning text and replaces the second line with a new line.
MEANING=(*REMOVE(1),*REPLACE(2,'texttext' 2 new) )
Meaning text with renumbered lines:
Line 1: 'texttext 2 new'
Line 2: 'texttext 3'
RESPONSE = *UNCHANGED / list-poss: *ADD(...) / *INSERT(...) / *REPLACE(...) / *REMOVE(...)
Specifies the response text written in the specified language that will be displayed via the /HELP-MSG-INFORMATION command. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
Each line of the response text (up to 256 lines) can be modified or deleted. In addition, new lines can be appended or inserted. The lines of the response text are numbered internally from 1 through to a maximum of 256 and can be addressed individually via these numbers. For examples, see the MEANING operand.
RESPONSE = *UNCHANGED
The response text remains unchanged.
RESPONSE = *ADD(...)
One or more new lines can be appended to the response text.
TEXT = list-poss: <c-string 1..74 with-low>
Response text consisting of one or more lines that is to be appended to the existing text.
RESPONSE = *INSERT(...)
One or more new lines can be inserted into the response text. Once all changes have been made, all subsequent lines are renumbered.
LINE-NUMBER = <integer 1..256>
The new text is inserted between the line number specified here and the previous line number.
TEXT = list-poss: <c-string 1..74 with-low>
Defines the new response text.
RESPONSE = *REPLACE(...)
The response text in the specified line is replaced by the new text entered.
LINE-NUMBER = <integer 1..256>
Specifies the number of the line containing text to be replaced.
TEXT = <c-string 1..74 with-low>
Specifies the text that is to replace the response text in the specified line.
RESPONSE = *REMOVE(...)
Lines can be deleted from the response text. Once all changes have been made, all subsequent lines are displaced and renumbered.
LINE-NUMBERS = *ALL / list-poss: <integer 1..256>
Specifies the line numbers.
INSERT-ATTRIBUTES = *UNCHANGED / *NONE / list-poss(30): <integer 0..29>(...)
The attributes of the specified inserts are not added, modified or deleted.
INSERT-ATTRIBUTES = *UNCHANGED
The attributes of the specified inserts are not modified.
INSERT-ATTRIBUTES = *NONE
All attributes of the specified inserts are deleted.
INSERT-ATTRIBUTES = <integer 0..29>(...)
The attributes of the specified inserts (numbered 00 through 29) can be added, modified or deleted; see also the //ADD-MSG statement.
NAME = *UNCHANGED / *NONE / <structured-name 1..20>
The insert name is to be modified. Insert names are evaluated by MIP.
DEFAULT-VALUE = *UNCHANGED / *NONE / <c-string 1..54 with-low> / *EMPTY-STRING
Modification of the default text that is inserted in the message text in place of the insert if no current text is defined in the MSG7X macro.
DEFAULT-VALUE = *UNCHANGED
The default text remains unchanged.
DEFAULT-VALUE = *NONE
The default text is deleted.
Example
INSERT-ATTRIBUTES=(0(NAME=*IDENTIFIER),4(NAME=*NONE),
2(DEFAULT-VALUE=*NONE),1(AUTO-HELP=*YES(CMD)))
DEFAULT-VALUE = <c-string 1..54 with-low>
Defines a new insert text. Note the length restrictions for message texts. Further information is provided in the "Introduction to System Administration” [5 (Related publications)].
DEFAULT-VALUE = *EMPTY-STRING
Defines an empty string. For compatibility reasons the DEFAULT-VALUE = *NULL operand value continues to be supported in batch jobs and procedures.
Example
INSERT-ATTRIBUTES=(0(DEFAULT-VALUE = *EMPTY-STRING),
1(DEFAULT-VALUE ='$TSOS'),4(DEFAULT-VALUE=*NONE))
AUTOMATIC-HELP = *UNCHANGED / *NO / *YES(...)
If a message code or part of a message code is output using an insert (e.g. in the case of DMS errors only the message number is output), the automatic help function causes MIP to output the associated message text in addition to this message code, see "ADD-MSG - Add message unit".
AUTOMATIC-HELP = *NO
Only the message code is output.
AUTOMATIC-HELP = *YES(...)
The message code and the message text are output
PREFIX = *BY-INSERT-VALUE / <name 3...7>
The complete message text is output for an insert included in the error message or for an explicitly specified message number.