Input parameters for the function routine are:
SSOB Contents: MVS™ sets the following fields in the SSOB control block on input:
- Field Name
- Description
- SSOBID
- Identifier 'SSOB'
- SSOBLEN
- Length of the SSOB (SSIBHSIZ) control block
- SSOBFUNC
- SSI function code 9 (SSOBWTO)
- SSOBSSIB
- Address of the SSIB control block
- SSOBRETN
- Return code from previous function routine (when SSI function
code 9 is operating in broadcast mode).
- SSOBINDV
- Address of the function dependent area (SSWT control block)
SSIB Contents: MVS sets the following fields in the SSIB control block on input:
- Field Name
- Description
- SSIBID
- Identifier 'SSIB'
- SSIBLEN
- Length of the SSIB (SSIBSIZE) control block
- SSIBSSNM
- Subsystem name — name of the subsystem which is enabled to receive
this function code.
SSWT Contents: MVS sets the following fields on input when either a single-line WTO,
multi-line WTO, or WTOR is being passed on the SSI call.
SSWT Contents for a Single-line WTO: MVS sets the following fields in
the SSWT control block on input for a single-line WTO:
- Field Name
- Description
- SSWTLEN
- Length of the SSWT (SSWTSIZE) control block
- SSWTWQE
- Address of the WQE control block
- SSWTNMOD
- Value of SUBSMOD keyword on the WTO macro
- SSWTPRSP
- Indicates whether the SSWTPRTY field is valid
Note: Because messages
are no longer assigned priorities, this field is ignored. It remains
present for compatibility purposes only.
- SSWTPRTY
- Value of the PRTY keyword on the WTO macro
Note: Because messages
are no longer assigned priorities, this field is ignored. It remains
present for compatibility purposes only.
- SSWTSNSP
- Indicates whether the JOBNAME keyword was specified on the WTO
- SSWTSISP
- Indicates whether the JOBID keyword was specified on the WTO
Figure 1 shows the environment for a
single-line WTO in the SSWT control block.
Figure 1. Environment for a Single-line
WTO in the SSWT Control Block
WQE Contents for a Single-line WTO: MVS sets the following fields in the WQE control
block on input for a single-line WTO:
- Field Name
- Description
- WQETXTLN
- Length of the message text
- WQETS
- EBCDIC time stamp
- WQEJOBNM
- Jobname (inserted by the primary subsystem)
- WQETXT
- Message text
- WQEXA
- Indicators
- WQEWTOR — indicates the message is a WTOR
- WQEAUTH — indicates the message is issued by an authorized
program.
- WQEASID
- ASID of the message issuer
- WQETCB
- TCB address of the message issuer
- WQESEQ#
- Message DOM id
- WQEMCSF1
- Indicators
- WQEMCSA — indicates the WQEROUT and WQEDESCD fields are
valid
- WQEMCSB — indicates the WQECNID and WQECNNME fields are
valid
- WQEMCSC — indicates the message is a command response
- WQEMCSD — indicates the WQEMSGTP field is valid
- WQEMCSE — indicates the message is reply to WTOR
- WQEMCSFF — indicates BRDCAST was specified on the WTO
- WQEMCSG — indicates HCONLY was specified on the WTO.
- WQEMCSF2
- Indicators
- WQEMCSM — indicates the message is a hardcopy image of
the operator command
- WQEMCSN — indicates that NOCPY was specified on the WTO.
- WQEMSGTP
- Message type
- WQEROUT
- Routing codes
- WQEFLG1
- Indicators
- WQERETAN — indicates that the message is retained by AMRF
- WQENMOD — indicates the subsystem cannot modify the message
- WQEPPNA — non-action message issued by a non-authorized
program
- WQERISS — indicates the message is an SVC reissue of a
message that has already been processed by SVC. WTO MPF and the SSI
have already processed the message. Note that MPF processing occurs
only during the original SVC WTO.
- WQEDESCD
- Descriptor codes
- WQEJSTCB
- Address of the job step TCB
- WQEVRSN
- Version level — contains the WQEVRID
- WQESYSNM
- System name
- WQEXMOD
- Copy of the MPF/IEAVMXIT user exit request flags. Indicator:
- WQERDTM — indicates that an MPF exit has requested the
deletion of the message. You can override the requested deletion of
the message by setting this bit off.
- WQEMLVL
- Message level
- WQEERC
- Extended routing codes
- WQELENG
- Length of WQE — contains the WQESIZE
- WQEKEY
- Value of the KEY keyword on the WTO
- WQETOKN
- Value of the TOKEN keyword on the WTO
- WQECNID
- Console ID
- WQEOJBID
- Originating job ID
- WQEOJBNM
- Originating job name
- WQEAUTOT
- Value of the automation token from MPF
- WQEERFS
- Extended request flags from the MPF/IEAVMXIT user exit
- WQECNNME
- Console name
- WQECART
- Value specified on the CART keyword on the WTO
- WQEBENIP
- Indicators
- WQEDOMD — indicates the message has been deleted by the
DOM macro.
- WQENBEW — indicates the message created by a branch-entered
WTO. Branch-entered WTOs are WTOs that MVS has called for subsequent SVCs. Note that the ASCB/TCB for
SSI function code 9 is not the same as the ASCB/TCB of the issuer
of the branch-entered WTO.
- WQENHABD — indicates the message has been displayed on
the IPL or system console. This is a result of issuing a WTO with
SYNCH=YES specified.
- WQECASEL
- Message color
- WQEHASEL
- Message highlighting
- WQEIASEL
- Message intensity
- WQEMISC
- Indicator
- WQEAUTO — indicates AUTO(Y) specified in the MPF for this
message.
SSWT Contents for the First Line of a Multi-line WTO: MVS sets the following fields in
the SSWT control block on input for a multi-line WTO:
See "SSWT Contents for a Single-line WTO" for the fields that MVS sets as they are the same except
for the SSWTMIN field which contains the following:
- Field Name
- Description
- SSWTMIN
- Address of the minor WQE
Figure 2 shows the environment for the
first line of a multi-line WTO in the SSWT control block.
Figure 2. Environment for the First Line
of a Multi-line WTO in the SSWT Control Block
WQE (major WQE) Contents for the First Line of a Multi-line
WTO: MVS sets the following fields in
the WQE control block for the first line of a multi-line WTO:
- Field Name
- Description
- WMJMMLW
- Multi-line indicator
- WMJMMLWB — indicates the WQE is multi-line
- WMJMAREA
- Value specified on the WTO AREA keyword
- WMJMTXTL
- Length of message text
- WMJMTS
- EBCDIC time stamp
- WMJMJBNM
- Jobname (inserted by the primary subsystem)
- WMJMTXT
- Message text
- WMJMDSP
- Indicator
- WMJMDSPH — indicates the message issued by an authorized
program
- WMJMASID
- ASID of the message issuer
- WMJMTCB
- TCB address of the message issuer
- WMJMSEQ#
- Message DOM id
- WMJMMCS1
- Indicators
- WMJMCS1A — indicates that the WMJMRTC and WMJMDEC fields
are valid
- WMJMCS1B — indicates that the WMJMCNID and WMJMCNME fields
are valid
- WMJMCS1C — indicates the message is a command response
- WMJMCS1D — indicates the WMJMMT field is valid
- WMJMCS1E — indicates the message is a reply to the WTOR
- WMJMCS1F — indicates the BRDCAST keyword is specified on
the WTO
- WMJMCS1G — indicates the HCONLY is specified on the WTO
- WMJMMCS2
- Indicators
- WMJMCS2E — indicates the message is the hardcopy image
of the operator command
- WMJMCS2F — indicates the NOCPY is specified on the WTO
- WMJMLTY1
- Line type indicator
- WMJMLTYA —control line
- WMJMLTYB — label line
- WMJMLTYC — data line
- WMJMLTYD — end line
Note: The WMJMLTYC and WMJMLTYD fields can be on at same time.
- WMJMRTC
- Routing codes
- WMJMFLG1
- Indicator
- WMJMRETN — indicates the message will be retained by AMRF
- WMJMNMOD — indicates the subsystem cannot modify the message
- WMJMPPNA — indicates the message is issued by the problem
program
- WMJMRISS — indicates the message is an SVC reissue of a
message that has already been processed by SVC WTO. MPF and the SSI
have already processed the message. Note that MPF processing occurs
only during the original SVC WTO. Examples of using this indicator
include messages that originate on one system (MVS sysplex), but are transported for display
to another system (JES3 complex).
- WMJMDEC
- Descriptor codes
- WMJMJTCB
- Address of job step TCB
- WMJMVRSN
- Version level — contains the WQEVRID
- WMJMSNM
- System name
- WMJMXMOD
- Copy of the MPF/IEAVMXIT user exit request flags. Indicator:
- WMJMRDTM — indicates that an MPF exit has requested the
deletion of the message. You can override the requested deletion of
the message by setting this bit off.
- WMJMMLVL
- Message level
- WMJMERC
- Extended routing codes
- WMJMLENG
- Length of WQE — contains the WMJMSIZE
- WMJMKEY
- Value of the KEY keyword on the WTO
- WMJMTOKN
- Value TOKEN keyword on the WTO
- WMJMCNID
- Console ID
- WMJMOJBI
- Originating job ID
- WMJMOJBN
- Originating job name
- WMJAUTOT
- Value of the automation token from the MPF
- WMJERFS
- Extended request flags from the MPF/IEAVMXIT user exit
- WMJMCNME
- Console name
- WMJMCART
- Value is specified on the CART keyword on the WTO
- WMJBENIP
- Indicators
- WMJMDOMD — indicates the message has been deleted by the
DOM macro.
- WMJMNBEW — indicates the message created by the branch-entered
WTO. Branch-entered WTOs are WTOs that MVS has called for subsequent SVCs. Note that the ASCB/TCB for
SSI function code 9 is not the same as the ASCB/TCB of the issuer
of the branch-entered WTO.
- WMJMHABD — indicates the message has been displayed on
the IPL or system console. This is a result of issuing a WTO with
SYNCH=YES specified.
- WMJCASEL
- Message color
- WMJHASEL
- Message highlighting
- WMJIASEL
- Message intensity
- WMJMMISC
- Indicator
- WMJMAUTO — indicates the AUTO(Y) is specified in MPF for
this message
WQE (minor WQE) Contents for Subsequent Lines of a Multi-line
WTO: MVS sets the following fields
in the WQE on input for subsequent lines of a multi-line WTO:
- Field Name
- Description
- WMNMLT1
- Line type indicators
- WMNMLT1B — label line
- WMNMLT1C — data line
- WMNMLT1D — end line
Note: The WMNMLT1C and WMNMLT1D fields can be on at same time.
- WMNMLTH1
- Length of the minor WQE
- WMNMTL1
- Length of the minor text
- WMNMTXT1
- Minor line text
- WMN1XMOD
- Copy of the request flags from the MPF/IEAVMXIT user exit
Figure 3 shows the environment for
minor lines of a multi-line WTO in the SSWT control block.
Figure 3. Environment for Minor Lines
of a Multi-line WTO in the SSWT Control Block
Multiline use information: The following example illustrates the
method in which the system presents a multiline message to the SSI
for updating. Consider the six-line message, IEE889I:
1 IEE889I 09.38.52 CONSOLE DISPLAY 191
2 MSG: CURR=0 LIM=1500 RPLY:CURR=0 LIM=10 SYS=SCOTT01 PFK=01
3 CONSOLE ID --------------- SPECIFICATIONS ---------------
4 SYSLOG COND=H AUTH=CMDS NBUF=N/A
5 ROUTCDE=ALL
6 LOG BUFFERS IN USE: 0 LOG BUFFER LIMIT: 1000
A multiline message consists of a major WQE (the first line) and
minor WQEs (subsequent lines). Minor WQEs are paired when possible.
In IEE889I, the two minor WQE pairs are 2 & 3 and 4 & 5 . The remaining minor WQE, 6 , is not paired. The pairing of minor WQEs affects
how the system passes message lines to the SSI, as shown below in Table 1.
The system passes IEE889I to the SSI six times. On the first call,
the SSI can modify only 1 , the major
WQE. On the second call, only 2 (the
first line of a minor WQE pair) may be modified; on the third call,
only 3 (the second line of a minor WQE
pair) may be modified, and so on. The system passes IEE889I to the
SSI six times, giving the SSI one opportunity to modify each of the
six lines.
Table 1. SSI updating
of multi-line messages| On this call... |
...the system passes these lines to the SSI... |
...and the SSI can modify this line: |
|---|
| 1 |
1 |
1 |
| 2 |
1
2
|
2 |
| 3 |
1
2
3
|
3 |
| 4 |
1
4
|
4 |
| 5 |
1
4
5
|
5 |
| 6 |
1
6
|
6 |
The SSI assigns fields to point at the lines of a multi-line message.
SSWTWQE always points at the major WQE. If minor WQEs are present,
then SSWTMIN points at the first minor WQE of the pair. If there is
a second line of a minor WQE pair, WMNMNX1 (which is within the first
minor WQE) points at it.
SSWT Contents for a WTOR (always single-line): MVS sets the following fields
in the SSWT control block on input for a WTOR (always single-line):
See "SSWT Contents for a Single-line WTO" for the fields that MVS sets as they are the same except
for the SSWTORE field which contains the following:
- Field Name
- Description
- SSWTORE
- Address of the ORE control block
WQE Contents for a WTOR (always single-line): The
fields in the WQE control block for a WTOR (always single-line) that MVS sets on input contain the same
information as the WQE control block for a single-line WTO. See "WQE
Contents for a Single-line WTO and WTOR" for this information.
ORE Contents for a WTOR (always single-line): MVS sets the following fields in
the ORE control block on input for a WTOR (always single-line):
- Field Name
- Description
- ORERPYA
- Address of the WTOR issuer's reply buffer
- OREECBA
- Address of the WTOR issuers ECB
- ORECBID
- Acronym — 'ORE'
- OREVRSN
- Version level — OREVRID
- ORELNTH
- Maximum length of the requested reply (specified by the WTOR issuer)
- ORERPIDB
- Binary reply ID
Figure 4 shows the environment for a
WTOR in the SSWT control block.
Figure 4. Environment for a WTOR in the
SSWT Control Block
z/OS MVS Using the Subsystem Interface
Copyright IBM Corporation 1990, 2014