IBM Support

OA44805: IMPROVE DESCRIPTION OF THE IMS MESSAGE KEYWORD MGSDISP IN SAZOS PRODUCT AUTOMATION PROGRAMMER'S REFERENCE AND OPERATOR'S GUIDE

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as documentation error.

Error description

  • The Description information for the MSGDISP Keyword in the
    Section: Defining IMS Messages in the SAzOS Product Automation
    Programmer's Reference and Operator's Guide (SC34-2643) needs
    clarification of which values can be entered by themself and
    which are mutually exclusive.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All SA z/OS V3R3 and V3R4 customers using    *
    *                 IMS Product Automation.                      *
    ****************************************************************
    * RECOMMENDATION:                                              *
    ****************************************************************
    The IMS exit policy requirements are not clear.
    

Problem conclusion

  • Product documentation is updated as follows:
    +------ System Automation for z/OS Version 3 Release 3 --------+
    |                                                              |
    |PROGRAM NUMBER: 5698-SA3                                      |
    |                                                              |
    |TITLE:       System Automation for z/OS         SC34-2569-02  |
    |             Product Automation Programmer's Reference        |
    |             and Operator's Guide                             |
    |                                                              |
    |CHAPTER:    3.0 IMS Automation                                |
    |SECTION:    3.1 IMS Automation Concepts                       |
    |SUBSECTION: 3.1.4 IMS Message Processing                      |
    |TOPIC:      3.1.4.2 Using the IMS Automation Message Exit     |
    |SUBTOPIC:   3.1.4.2.1 Defining IMS Message                    |
    |                                                              |
    |CHANGE:                                                       |
    |                                                              |
    | Replace Table 3 with the following table:                    |
    |                                                              |
    | .__________________________________________________________. |
    | | Table 3. Keywords in IMS Message Definitions             | |
    | |_________.________________________________________________| |
    | | Keyword | Description                                    | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | OFFSET  | This keyword is required to load the message   | |
    | |         | into the exit. It specifies the word number in | |
    | |         | the message that represents the message ID.    | |
    | |         | The format for the data is:                    | |
    | |         |                                                | |
    | |         | n                                              | |
    | |         |                                                | |
    | |         | Where n is an integer number.                  | |
    | |         |                                                | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | MSGDISP | This keyword specifies the default actions for | |
    | |         | a message ID.                                  | |
    | |         | The syntax for the format of this data is:     | |
    | |         |                                                | |
    | |         | >>---(--.------------.--)--><                  | |
    | |         |         |  <---,---< |                         | |
    | |         |         |--NONE------|                         | |
    | |         |         |--AUTOMATE--|                         | |
    | |         |         | '--AUTO--' |                         | |
    | |         |         |--FORWARD---|                         | |
    | |         |         .--SUPPRESS--.                         | |
    | |         |                                                | |
    | |         | The actions that are available are:            | |
    | |         |                                                | |
    | |         | NONE - The message is not acted on by the exit.| |
    | |         |        Use this option to set a default of no  | |
    | |         |        action when used with the TOKEN keyword.| |
    | |         |                                                | |
    | |         | AUTOMATE|AUTO - WTO the message for SA z/OS to | |
    | |         |                 trap.                          | |
    | |         |                                                | |
    | |         | FORWARD - This forwards the message segments to| |
    | |         |           the TYPE 1 exit DFSAOUE0, if it      | |
    | |         |           exists.                              | |
    | |         |                                                | |
    | |         | SUPPRESS - The message is suppressed from the  | |
    | |         |            IMS Master Console. IMS reserves the| |
    | |         |            right not to suppress messages that | |
    | |         |            it determines are critical.         | |
    | |         |                                                | |
    | |         | Multiple actions can be entered separated by a | |
    | |         | comma.                                         | |
    | |         |                                                | |
    | |         | FORWARD and SUPPRESS are mutually exclusive.   | |
    | |         |                                                | |
    | |         | The default action is AUTOMATE if no TOKEN     | |
    | |         | keyword is present. If a TOKEN keyword is      | |
    | |         | present the default action is NONE.            | |
    | |         |                                                | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | TOKEN   | This keyword specifies the matching token      | |
    | |         | values for user messages. It is optional, but  | |
    | |         | if present only messages that match the values | |
    | |         | specified are WTO'd. The syntax for the format | |
    | |         | of this data is:                               | |
    | |         |                                                | |
    | |         | >>--(--(number,word_text)-.------------.--)--><| |
    | |         |                           .-- msgdisp--.       | |
    | |         |        <----------------,------------------<   | |
    | |         |                                                | |
    | |         | where number is the word number to be checked  | |
    | |         | and word_text is the text to be checked. The   | |
    | |         | optional msgdisp has the same meaning and      | |
    | |         | syntax as the MSGDISP keyword.                 | |
    | |         |                                                | |
    | |         | Words are counted from the beginning of the    | |
    | |         | message starting from 1. A word is considered  | |
    | |         | to be a contiguous set of characters that      | |
    | |         | contain alphanumerics or any of the '$# _ ?'   | |
    | |         | characters. Any other characters are treated   | |
    | |         | as word delimiters.                            | |
    | |         |                                                | |
    | |         | The word_text specification is checked for the | |
    | |         | length specified. This allows for trailing data| |
    | |         | to be ignored. The format of the number is a   | |
    | |         | single integer. The format for the value is a  | |
    | |         | single alphanumeric word, no blanks or special | |
    | |         | characters are allowed. The case of the value  | |
    | |         | is ignored.                                    | |
    | |         |                                                | |
    | .__________________________________________________________. |
    |                                                              |
    |                                                              |
    |                                                              |
    +--------------------------------------------------------------+
    +------ System Automation for z/OS Version 3 Release 4 --------+
    |                                                              |
    |PROGRAM NUMBER: 5698-SA3                                      |
    |                                                              |
    |TITLE:       System Automation for z/OS         SC34-2643-00  |
    |             Product Automation Programmer's Reference        |
    |             and Operator's Guide                             |
    |                                                              |
    |CHAPTER:    3.0 IMS Automation                                |
    |SECTION:    3.1 IMS Automation Concepts                       |
    |SUBSECTION: 3.1.4 IMS Message Processing                      |
    |TOPIC:      3.1.4.2 Using the IMS Automation Message Exit     |
    |SUBTOPIC:   3.1.4.2.1 Defining IMS Message                    |
    |                                                              |
    |CHANGE:                                                       |
    |                                                              |
    | Replace Table 5 with the following table:                    |
    |                                                              |
    | .__________________________________________________________. |
    | | Table 5. Keywords in IMS Message Definitions             | |
    | |_________.________________________________________________| |
    | | Keyword | Description                                    | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | OFFSET  | This keyword is required to load the message   | |
    | |         | into the exit. It specifies the word number in | |
    | |         | the message that represents the message ID.    | |
    | |         | The format for the data is:                    | |
    | |         |                                                | |
    | |         | n                                              | |
    | |         |                                                | |
    | |         | Where n is an integer number.                  | |
    | |         |                                                | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | MSGDISP | This keyword specifies the default actions for | |
    | |         | a message ID.                                  | |
    | |         | The syntax for the format of this data is:     | |
    | |         |                                                | |
    | |         | >>---(--.------------.--)--><                  | |
    | |         |         |  <---,---< |                         | |
    | |         |         |--NONE------|                         | |
    | |         |         |--AUTOMATE--|                         | |
    | |         |         | '--AUTO--' |                         | |
    | |         |         |--FORWARD---|                         | |
    | |         |         .--SUPPRESS--.                         | |
    | |         |                                                | |
    | |         | The actions that are available are:            | |
    | |         |                                                | |
    | |         | NONE - The message is not acted on by the exit.| |
    | |         |        Use this option to set a default of no  | |
    | |         |        action when used with the TOKEN keyword.| |
    | |         |                                                | |
    | |         | AUTOMATE|AUTO - WTO the message for SA z/OS to | |
    | |         |                 trap.                          | |
    | |         |                                                | |
    | |         | FORWARD - This forwards the message segments to| |
    | |         |           the TYPE 1 exit DFSAOUE0, if it      | |
    | |         |           exists.                              | |
    | |         |                                                | |
    | |         | SUPPRESS - The message is suppressed from the  | |
    | |         |            IMS Master Console. IMS reserves the| |
    | |         |            right not to suppress messages that | |
    | |         |            it determines are critical.         | |
    | |         |                                                | |
    | |         | Multiple actions can be entered separated by a | |
    | |         | comma.                                         | |
    | |         |                                                | |
    | |         | FORWARD and SUPPRESS are mutually exclusive.   | |
    | |         |                                                | |
    | |         | The default action is AUTOMATE if no TOKEN     | |
    | |         | keyword is present. If a TOKEN keyword is      | |
    | |         | present the default action is NONE.            | |
    | |         |                                                | |
    | |_________.________________________________________________| |
    | |         |                                                | |
    | | TOKEN   | This keyword specifies the matching token      | |
    | |         | values for user messages. It is optional, but  | |
    | |         | if present only messages that match the values | |
    | |         | specified are WTO'd. The syntax for the format | |
    | |         | of this data is:                               | |
    | |         |                                                | |
    | |         | >>--(--(number,word_text)-.------------.--)--><| |
    | |         |                           .-- msgdisp--.       | |
    | |         |        <----------------,------------------<   | |
    | |         |                                                | |
    | |         | where number is the word number to be checked  | |
    | |         | and word_text is the text to be checked. The   | |
    | |         | optional msgdisp has the same meaning and      | |
    | |         | syntax as the MSGDISP keyword.                 | |
    | |         |                                                | |
    | |         | Words are counted from the beginning of the    | |
    | |         | message starting from 1. A word is considered  | |
    | |         | to be a contiguous set of characters that      | |
    | |         | contain alphanumerics or any of the '$# _ ?'   | |
    | |         | characters. Any other characters are treated   | |
    | |         | as word delimiters.                            | |
    | |         |                                                | |
    | |         | The word_text specification is checked for the | |
    | |         | length specified. This allows for trailing data| |
    | |         | to be ignored. The format of the number is a   | |
    | |         | single integer. The format for the value is a  | |
    | |         | single alphanumeric word, no blanks or special | |
    | |         | characters are allowed. The case of the value  | |
    | |         | is ignored.                                    | |
    | |         |                                                | |
    | .__________________________________________________________. |
    |                                                              |
    |                                                              |
    |                                                              |
    +--------------------------------------------------------------+
    

Temporary fix

Comments

APAR Information

  • APAR number

    OA44805

  • Reported component name

    SYSTEM AUTO Z/O

  • Reported component ID

    5698SA300

  • Reported release

    340

  • Status

    CLOSED DOC

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2014-03-18

  • Closed date

    2014-04-03

  • Last modified date

    2014-04-03

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

Publications Referenced
SC34256902SC34264300   

Fix information

Applicable component levels

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSWRCJ","label":"IBM Tivoli System Automation for z\/OS"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"340","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
03 April 2014