OW34517: UPMSG RE-DOCUMENTED

APAR status

• Closed as documentation error.

Error description

• UPMSG -UP Message Handler is to be re-documented in the SA/390
  Programmer's Reference Manual.
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: All SA OS/390 R3 customers.                  *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  The documentation for UPMSG has been omitted since AOC/MVS V1R4.
  However as the function is still available it is required for
  it to be re-documented.
  

Problem conclusion

• Product documentation is updated as follows:
  +----- SA OS/390 version 1 Release 3 Modification Level 0 -----+
  |                                                              |
  |PROGRAM NUMBER: 5645-005                                      |
  |                                                              |
  |TITLE:  System Automation for OS/390 V1R3.0 Technical         |
  |        Reference                              GC28-1593-01   |
  |                                                              |
  |PART:        4. Routines                                      |
  |TOPIC:       Generic Routines                                 |
  |                                                              |
  |CHANGE:                                                       |
  |                                                              |
  | The following should be added to the end of this topic:      |
  |                                                              |
  |UPMSG                                                         |
  |                                                              |
  |  Note:  UPMSG is provided only for compatibility with AOC/MVS|
  |  Release 1 customer automation tables and routines.          |
  |  It is recommended that you use ACTIVMSG UP=YES instead.     |
  |                                                              |
  | Purpose                                                      |
  |                                                              |
  |  The UPMSG common routine is used to handle the final active |
  |  message (UP message) for an application. This should now be |
  |  done using the ACTIVMSG generic routine, by specifying the  |
  |  parameter UP=YES.                                           |
  |                                                              |
  |  The UPMSG generic routine reformats the parameters entered, |
  |  and passes them to ACTIVMSG for processing.  It is more     |
  |  efficient to call ACTIVMSG directly.                        |
  |                                                              |
  |  UPMSG can be called from the NetView automation table, in   |
  |  which case no parameters are required, or from an automation|
  |  procedure (CLIST), in which case the JOBNAME parameter must |
  |  be supplied.                                                |
  |                                                              |
  | Syntax                                                       |
  |                                                              |
  |                                                              |
  |   >>--UPMSG-----------------------------------------><       |
  |              |                 |  |              |           |
  |              |_JOBNAME=jobname_|  |_MSGTYPE=type_|           |
  |                                                              |
  | Parameters                                                   |
  |                                                              |
  |  JOBNAME=jobname                                             |
  |      The name of the job the message is for, if the name     |
  |      cannot be obtained from the message job name field in   |
  |      the NetView automation table. The JOBNAME keyword is    |
  |      optional.                                               |
  |                                                              |
  |  MSGTYPE=type                                                |
  |      The type of command to be issued in response to the     |
  |      arrival of the message.  If specified, the value is     |
  |      passed through to ACTIVMSG. If not, the default type    |
  |      is UP.  A type can be specified without the MSGTYPE     |
  |      keyword.                                                |
  |                                                              |
  | Restrictions                                                 |
  |                                                              |
  |  o   Using UPMSG has performance implications as its         |
  |      parameters are validated twice (once by UPMSG and again |
  |      by ACTIVMSG).                                           |
  |                                                              |
  | Usage                                                        |
  |                                                              |
  |  The UPMSG common routine is being retired. ACTIVMSG should  |
  |  be used in its place.                                       |
  |                                                              |
  +--------------------------------------------------------------+
  

Temporary fix

Comments

APAR Information

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

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

Fix information

Applicable component levels