SYSOUT information elements

When SYSOUT information is requested, for each SYSOUT element that matches specified filter requirements, a SYSOUT information element is added to the corresponding job level information element (STATJQ) chain pointed to by STJQSE. Each element is composed of the following:

A variable-sized prefix (mapped by the STATSE DSECT)
A fixed-size SYSOUT element header (mapped by the STATSEHD DSECT)
One or more variable-sized data sections

SYSOUT Information Element Prefix: Each SYSOUT information element starts with a prefix area. This area is mapped by the STATSE DSECT in the IAZSSST macro. STJQSE of the corresponding job information element (STATJQ) points to the start of the first prefix area. Subsequent areas for the same job are chained using the STSEJNXT or SYSEJNXT_64 field. Because the size of the prefix area can vary as a result of service being applied, do not use the equate STSESIZE to access the data that follows the prefix. To obtain the address of subsequent fields, add the field STSEOHDR to the start of the prefix.

The fields in the STATSE prefix are:

Field Name: Description
STSEEYE: Eyecatcher C‘SOUT’
STSEOHDR: Offset from the start of the STATSE to the first SYSOUT information data section.
STSEJNXT: 31-bit address of the next STATSE area for this job.
STSEJNXT_64: 64-bit address of the next STATSE area for this job.
STSEJOB: 31-bit address of the STATJQ for the job that owns this SYSOUT.
STSEJOB_64: 64-bit address of the STATJQ for the job that owns this SYSOUT.
STSEVRBO: 31-bit address of the STATVO for the job that owns this SYSOUT.
STSEVRBO_64: 64-bit address of the STATVO for the job that owns this SYSOUT.

SYSOUT Information Element Data Sections: The variable data sections which contain information about the SYSOUT follow the STATSE prefix. Each section starts with a 2-byte length, a 1-byte section type, and a 1-byte section modifier. The data length can be from 1 through 65535 bytes. The type and modifier are used to determine the mapping needed to access the data in the section. The first section after the STATSE prefix is a special 4-byte section which describes the length and type of all sections that follow. The DSECTs that map each section are in the IAZSSST macro.

SYSOUT Queue Element 1st Section: This section is mapped by the STATSEHD DSECT and is identified by a type of STSH1HDR ('40'x) and a modifier of STSH1MOD ('00'x). This is the only fixed-size section with a length of STSHSIZE (4 bytes). The length in this section is the total length of all sections that follow.

The fields in the STATSEHD section are:

Field Name: Description
STSHLEN: Length of all sections which follow (including this section)
STSHTYPE: Section type identifier of STSH1HDR ('40'x)
STSHMOD: Section type modifier of STSH1MOD ('00'x)
STSHSIZE: Length of this section (4 bytes)

SYSOUT Element JES2 Terse Section: This section is mapped by the STATSJ2T DSECT and is identified by a type of STS2TERS ('42'x) and a modifier of STS2TMOD ('00'x). This section is present if the SYSOUT information came from a JES2 subsystem. This section contains JES2-specific information common to all SYSOUT.

The fields in the STATSJ2T section are:

Field Name

Description

STS2LEN

Length of this section.

STS2TYPE

Section type identifier of STS2TERS ('42'x)

STS2MOD

Section type modifier of STS2TMOD ('00'x)

STS2FLG1

General flag byte

Bit Value: Description
STS21DSH: JOE representing this SYSOUT data set has been cloned
STS21TSO: JOE is available for TSO OUTPUT processing
STS21USR: SYSOUT element is on the user ID queue

STS2OGNM

JOE output group name

STS2CRTM

JOE create time (STCK format system clock time)

STS2RNOD

Binary destination node

STS2RRMT

Binary destination remote number

STS2RUSR

Destination user route code

STS2TSWB

JOE level SWB MTTR (8 byte field)

STS2CKPT

Checkpoint MTTR (8 byte) if checkpoint is valid (else zero)

STS2JOEI

Index of JOE

STS2OFSL

SPOOL offload selection mask

STS2BUSY

Binary busy byte

SYSOUT Element JES3 Terse Section: This section is mapped by the STATSJ3T DSECT. This section is meaningful only if the job is owned by a JES3 subsystem.

Field name

Description

STS3LEN

Length of this section

STS3TYPE

Section type identifier of

STS3MOD

Section type modifier of

STS3FLG1

Flag byte:

Bit value: Description
STS31XSY: Extended keywords used
STS31WSI: Indicates that one SYSOUT element (STATSE) has been returned for the Work Selection Identifier in STS3WSI. The returned STATSE consolidates the information that would normally be returned in multiple SYSOUT elements with identical output characteristics.
STS31FMT: Indicates that a //*FORMAT JCL statement was used to specify processing instructions to JES3 for the SYSOUT data set. The scheduler facilities call cannot be used to modify or obtain characteristics of the SYSOUT data set.

STS3WSI

The Work Selection Identifier assigned to each SYSOUT data set:

The identifier is a value assigned by JES3 based on the work selection output characteristics of a SYSOUT data set.
For a job, SYSOUT data sets with identical work selection output characteristics will be assigned the same value.
The assigned values are unique to the job and cannot be used across jobs.

STS3SIZE

Length of section

SYSOUT Element Terse Section: This section is mapped by the STATSETR DSECT and is identified by a type of STSTTERS ('41'x) and a modifier of STSTTMOD ('00'x). All job information elements have at least one section of this type. This section contains information common to all types of jobs.

The fields in the STATSETR section are:

Field Name

Description

STSTLEN

Length of this section.

STSTTYPE

Section type identifier of STSTTERS ('41'x)

STSTMOD

Section type modifier of STSTTMOD ('00'x)

STSTOUID

User ID that owns the SYSOUT

STSTSECL

SECLABEL assigned to the SYSOUT

STSTDEST

Destination of SYSOUT. Whether or not the local node name appears in the destination depends on the setting of the STAT1LCL option bit.

STSTCLAS

Class assigned to the SYSOUT. If JES3 is the subsystem returning information, and the data set has not been processed by output processing, this is the class of the first instance of the output.

STSTNREC

Number of records in the SYSOUT element

STSTPAGE

Number of pages in the SYSOUT element

STSTLNCT

Number of lines in the SYSOUT element (JES3 only)

STSTBYCT

Number of bytes on spool consumed by the SYSOUT element (JES3 only)

STSTFORM

Form assigned to the SYSOUT

STSTFCB

Forms control buffer (FCB)

STSTUCS

Universal character set (UCS)

STSTXWTR

External writer name

STSTPMDE

Processing mode (PRMODE)

STSTFLSH

Flash

STSTCHAR

Character sets assigned to the SYSOUT (JES3 only)

STSTMODF

MODIFY=(modname) value (JES3 only)

STSTMODC

MODIFY=(,trc) value (JES3 only)

STSTFLG2

General flag byte

Bit Value: Description
STST2CIV: The token in STSTCTKN cannot be used. It is not valid. Ensure that the token is valid by verifying that bit STST2CIV is not on.

STSTSYS

MVS™ system name where output currently being processed (blank if not currently active)

STSTMEM

JES member name where output currently being processed (blank if not currently active).

STSTDEVN

Device name on which output currently being processed (blank if not currently active)

STSTHSTA

Current hold status of the SYSOUT

Bit Value: Description
STSTHOPR: An operator hold has been set using an operator command
STSTHUSR: A user hold has been set using JCL (such as HOLD=YES on the DD statement)
STSTHSYS: A system (error) hold has been set (see STSTHRSN for hold reason)
STSTHTSO: SYSOUT is held for TSO (JES3 only)
STSTHXWT: SYSOUT is held for an external writer (JES3 only)
STSTHBDT: SYSOUT is held on the BDT queue (JES3 only)
STSTHTCP: SYSOUT is held on the TCP queue (JES3 only)

STSTHRSN

System hold reason (see fields OHLDJxxx in IAZOHLD for the definition of possible values)

STSTDISP

Current OUTDISP value for the SYSOUT (JES2 only)

Field Value: Description
STSTDHLD: OUTDISP=HOLD
STSTDLVE: OUTDISP=LEAVE
STSTDWRT: OUTDISP=WRITE
STSTDKEP: OUTDISP=KEEP

STSTFLG1

General flag byte

Bit Value: Description
STST1BRT: BURST=YES requested
STST1DSI: 3540 held SYSOUT element
STST1IPA: SYSOUT destination includes an IP address
STST1CPD: SYSOUT element includes page mode data
STST1SPN: SYSOUT element was spun
STST1NSL: SYSOUT not selectable
STST1APC: SYSOUT has job level information (has a STOTAPPC type section)
STST1CTK: When SYSOUT was allocated, the DALRTCTK key was specified (client token returned)

STSTPRIO

Priority assigned to the SYSOUT

STSTSOID

EBDCIC SYSOUT identifier which can be used in operator commands for this SYSOUT element. The contents of this field are subsystem dependent and can change from one release to another.

STSTCTKN

SYSOUT token associated with the SYSOUT element. This token can be passed on subsequent extended status requests or on the SYSOUT API (SAPI). This token may be different that the SYSOUT token returned by dynamic allocation.

Using STSTCTKN

You may receive multiple tokens for a set of data sets meeting your status selection criteria. This is based on how the JES groups data sets into schedulable elements and may be different for each JES.

For example, if your status request specifies FORMS as the only selection criterion, you may still receive multiple tokens for a single job because other characteristics may vary or because of the way JES decided to group the data sets under a single schedulable element.

The Extended Status token will return the same group of data sets on a subsequent SAPI call unless:

The JES was restarted
Some of the output was modified such that a new schedulable element was created in place of an existing one
The schedulable element was either deleted by the operator or it was processed by another application or writer

Therefore, it is possible that you will receive SSS2EODS for what otherwise would be a valid token request. To make sure there are no data sets left in JES that meet your selection criteria, you should repeat a status request, examine the results, and issue another SAPI request until you get an output group for a different job. You can then continue with that job or issue a PUT for the received group with the KEEP disposition to return it back to the queue for some other output function to process.

STS1APC

SYSOUT data set has APPC JOB information associated with it

SYSOUT Verbose Element Prefix:

Field name: Description
STVOEYE: Eye catcher (C'SSVE')
STVOOHDR: Offset to first section
STVOJOB: 31-bit address of associated job queue data element - STATJQ
STVOJOB_64: 64-bit address of associated job queue data element - STATJQ
STVOJNXT: 31-bit address of next verbose SYSOUT element for JOB
STVOJNXT_64: 64-bit address of next verbose SYSOUT element for JOB
STVOSOUT: 31-bit address of associated SYSOUT data element - STATSE
STVOSOUT_64: 64-bit address of associated SYSOUT data element - STATSE
STVOSNXT: 31-bit address of next verbose SYSOUT element for STATSE
STVOSNXT_64: 64-bit address of next verbose SYSOUT element for STATSE
STVOSIZE: Size of prefix

SYSOUT Verbose Element 1st Header Section: This section is mapped by the STATSVHD DSECT and is identified by a type of STSV1HDR and a modifier of STSV1MOD (X'0').

Field name: Description
STSVLEN: Length of entire SYSOUT verbose element (Maximum value is 65535)
STSVYPE: Section type identifier of STSV1HDR
STSVMOD: Section type modifier of STSV1MOD (X'0')
STSVSIZE: Size of 1st Header Section

SYSOUT Element Verbose Section: This section is mapped by the STATSEVB DSECT and is identified by a type of STVSVRBO and a modifier of STVSVMOD (X'0').

Field name

Description

STVSLEN

Length of this section

STVSYPE

Section type identifier of STVSVRBO

STVSMOD

Section type modifier of STVSVMOD (X'0')

STVSFLG1

Section flag byte

Bit value: Description
STVS1ERR: Error obtaining verbose data (terse section returned).
STVSDSCL: Line count, page count, byte count, and record count (STVSLNCT, STVSPGCT, STVSBYCT, and STVSRCCT) are accurate. This bit will not be on if there was an abnormal termination or the data was created on a different node.
STVS1SPN: SPIN data set
STSVS1JSL: Spun JESLOG data set
STVS1SYS: System data set
STVS1SIN: Instream data set (SYSIN)
STVS1DUM: Dummy data set (SYSOUT data set which will not print)
STVS1ENF: All ENF signals are issued for this data set

STVSRECF

Record format

STVSPRCD

Procname for the step creating this data set

STVSSTPD

Stepname for the step creating this data set

STVSDDND

DDNAME for the data set creation

STVSTJN

APPC Transaction Program Jobname that created this data set. This field has been deprecated. Applications should use STOTJOBN in the STATSEOT section.

STVSTJID

APPC Transaction Program Job ID that created this data set. This field has been deprecated . Applications should use STOTJID in the STATSEOT section.

STVSTOD

Date and time of data set availability in TOD format (that is, this value is the high-order word of the TOD clock obtained with a STCK instruction)

STVSSEGM

Segment ID (zero if data set not segmented)

STVSDSKY

Data set number (key)

STVSMLRL

Maximum logical record length (LRECL)

STVSLNCT

Line count (valid only if STVSDSCL is ON in STVSFLG1)

Note: For JES3, the line, page, byte, and record counts (STVSLNCT, STSVPGCT, STSVBYCT, STSVRCCT) are updated when the data set is unallocated. Prior to then, the returned values, though valid, are not current.

STVSPGCT

Page count (valid only if STVSDSCL is ON in STVSFLG1)

STVSBYCT

Byte count after blank truncation, 63 bit right justified (valid only if STVSDSCL is ON in STVSFLG1)

STVSRCCT

Record count (JES3 only) (valid only if STVSDSCL is ON in STVSFLG1)

STVSDSN

SYSOUT data set name (valid only if STVSDSCL is ON in STVSFLG1)

STVSCOPY

Data set copy count

STVSFLSC

Number of flash copies

STVSCTKN

SYSOUT data set token

STVSCHAR

Printer translate table

STVSMODF

MODIFY=(modname)

STVSMODC

MODIFY=(,trc)

STVSSIZE

Length of section

SYSOUT Element JES2 Verbose Section: This section is mapped by the STATSEO2 DSECT and is identified by a type of STO2VRBO and a modifier of STO2TMOD. This section contains general information that is meaningful only if the job is owned by a JES2 subsystem.

Field name

Description

STO2LEN

Length of this section

STO2TYPE

Section type identifier of STO2VRBO

STO2MOD

Section type modifier of STO2TMOD (X'0')

STO2FLG1

General flags

Bit value: Description
STO21ERR: Error obtaining verbose data
STO21ORI: Field override section is populated (JES2 only).
Note: JES3 does not use this field override section.

STO2SPST

Data set SPOOL data token

Field Override Section: The following fields are populated if the data set is part of a demand select JOE. A demand select JOE is indicated by the flag STO21ORI being set to on. If the system or an individual job specifies demand select, then data sets are gathered into JOEs, regardless of whether the following list of characteristics are matching or not:

Forms
FCB
UCS
Flash
Burst

STO2FORM

Form assigned to the data set

STO2FCB

Forms Control Buffer (FCB)

STO2UCS

Universal Character Set (UCS)

STO2FLSH

Flash

STO2FLG2

General flags

Bit value: Description
STO21BRT: Indicates BURST=YES

STO2SIZE

Length of section

SYSOUT Element JES3 Verbose Section: This section is mapped by the STATSEO3 DSECT and is identified by a type of STO3VRBO and a modifier of STO3TMOD. This section contains general information that is meaningful only if the job is owned by a JES3 subsystem.

Field name

Description

STO3LEN

Length of this section

STO3TYPE

Section type identifier of STO3VRBO

STO3MOD

Section type modifier of STO3TMOD (X'0')

STO3FLG1

General flags

Bit value: Description
STO31ERR: Error obtaining verbose data

STO3CMTK

Modify token which can be included on a *MODIFY,U operator command to uniquely identify the data set

STO3SIZE

Length of section

SYSOUT Element Security Section (mapped by SAF token): This section is mapped by the STATSESO DSECT and is identified by a type of STSOSEC and a modifier of STSOSMOD (X'0').

Field name

Description

STSOLEN

Length of this section

STSOTYPE

Section type identifier of STSOSEC

STSOMOD

Section type modifier of STSOSMOD (X'0')

Field name: Description
STSOSMOD: Security section modifier

STSOFLG1

flag byte

Bit value: Description
STSO1ERR: Error obtaining verbose data

STSOOFFS

Offset to SAF token

STSOTOKN

Mapped SAF token

SYSOUT APPC transaction output section, (mapped by STATEOT DSECT): This section is mapped by the STATSEOT DSECT and is identified by a type of STOTAPPC and a modifier of STOTSMOD.

Field name: Description
STOTJOBN: APPC transaction program job name that created this data set
STOTJID: APPC transaction program job id that created this data set
STOTSTRT: APPC entry start time
STOTSTRD: APPC entry start date
STOTEXST: APPC execution start time
STOTACTO: APPC account number
STOTSIZE: Length of section