z/OS MVS Using the Subsystem Interface
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Output-Only Fields

z/OS MVS Using the Subsystem Interface
SA38-0679-00

These fields are returned to the application thread with information managed by the JES. Once the initial SSS2 control block has been set to X'00's (or after a previous IEFSSREQ request with SSS2CTRL having been set), the application thread must not modify the contents of any of these ‘Output-Only’ fields.
SSS2REAS
Output field

Reason code associated with SSOBRETN value of SSS2LERR or SSS2BDIS. See the explanation at Reason Codes for SSOBRETN being SSS2LERR and Reason Codes for SSOBRETN being SSS2BDIS.

SSS2JEST
Output field

JES token associated with this SAPI request. A zero value here implies that this is a new request. A new request implies that the SSS2DSN is null.

The application, once originally initializing this field to X'00's, must not modify or subsequently reference this field.

SSS2BTOK
Output field

Address of a JES initialized data area (a dynamic allocation text unit). This value must be copied to a dynamic allocation text unit pointer by the application thread prior to the dynamic allocation of the returned data set.

See PUT/GET Requests for information concerning programming considerations related to the use of SSS2BTOK.

SSS2COPY
Output field

Total number of copies requested by creator. A data set is returned through this interface only once no matter how many copies were requested by the creator.

SSS2CPYG
Output field

Copy groups

SSS2JOBR
Output field

Jobname of selected job

SSS2JBIR
Output field

Job ID of selected job

SSS2OJBI
Output field

Original jobid of selected job. (Original id may be different from current jobid.) (JES3 always returns blanks.)

SSS2CRER
Output field

Creator user ID of data set selected

SSS2JDVT
Output field

JCL definition vector table

SSS2PRMR
Output field

PRMODE of data set selected

SSS2DESR
Output field

Destination of selected data set

SSS2PGMR
Output field

Writer name of selected data set

SSS2FORR
Output field

Form number of selected data set

SSS2TJN
Output field

Transaction Program Jobname that created this data set

SSS2TJID
Output field

Transaction Program Job ID that created this data set

SSS2DSN
Output field

Data set name of selected data set. Must be blanks or zeros if SSS2JEST is zero.

You must not make assumptions regarding the format of the data set name.

SSS2SEGM
Output field

Segment id (zero if data set not segmented)

SSS2WRTN
Output field
SWB processing error - return code given:
SSS2WOK (0)
Processing successful.
SSS2WERR (4)
Processing failed.

Note that reason code field SSS2WRSN is also set.

SSS2WRSN
Output field

SWB processing error - reason code set to non-zero only if SSS2WRTN is non-zero

SSS2WRSN has the following value: SSSSCCRR where SSSSCCRR is defined as:
SSSS
Reason code from SJF service RR or a qualifier for a JES service error
CC
Return code from SJF service RR

CC is ‘00’ if RR is 4 or 8

RR
indicates the SJF service or JES service
  • 4 = JES SPOOL I/O Error
  • 8 = JES Memory management error
  • 12 = SJFREQ REQUEST=SWBTU_MERGE
  • 16 = SJFREQ REQUEST=PUTSWB
  • 20 = SJFREQ REQUEST=JDTEXTRACT
  • 24 = SWBTUREQ REQUEST=RETRIEVE
SSS2CLAR
Output field

SYSOUT class of selected data set

SSS2MLRL
Output field

Maximum logical record length (LRECL)

SSS2DSID
Output field

DSID for the selected data set. The value is derived from the value specified as the DSID keyword on a DD statement, which is only used for 3540 Diskette data sets.

SSS2RET1
Output field
SSS2GNVA
JES returned an output group name in SSS2OGNM (JES2 only).
SSS2DSCL
Line count, page count, byte count, and record count (SSS2LNCT, SSS2PGCT, SSS2BYCT, and SSS2RCCT) are accurate. This bit will not be on if there was an abnormal termination or the data was created on a different node.
SSS2DSF
First data set in output group
SSS2DSC
Output group being continued
SSS2DSL
Last data set in output group
SSS2IP
An Internet Protocol (IP) destination is available in the SJF data. See SSS2SWBT and SSS2SWTU.
SSS2BRST
BURST=YES specified
SSS2OPTJ
OPTCD=J specified
SSS2RET2
Output field
SSS2NCHR
Selection using printer translation tables not supported
SSS2NVOL
Selecting output based on a volume serial list not supported
SSS2NNHD
Returning addresses of NJE headers not supported
SSS2NMOD
Selecting output based on a modification is not supported
SSS2NPRI
Selecting output in priority order is not supported
SSS2NIPA
IP address selection not supported. Turned on if JES does not support and SSS2SIPA or SSS2SIPN is on
SSS2RET3
Output field
SSS2RSTC
Data set created by started task
SSS2RTSU
Data set created by time sharing user
SSS2RJOB
Data set created by batch job
SSS2RET4
Output field
SSS2CPDS
Data set has page mode data
SSS2SPUN
Data set was spun at close
SSS2SDSH
All data sets in group must be unallocated identically.
SSS2RET5
Output field Queue where the data set resides
SSS2RHLV
Data set on "HOLD/LEAVE" queue (JES2) or "Hold for TSO" queue (JES3)
SSS2RXWH
Data set on "Hold for XWTR" queue. This will never be true in a JES2 environment.
SSS2RHOL
Data set on one of the held queues.
SSS2RWTR
Data set on "Write/Keep" queue (JES2) or "Writer" queue (JES3).
SSS2RFOR
Record format

The following count fields (SSS2LNCT, SSS2PGCT, SSS2BYCT, and SSS2RCCT) are valid only if SSS2DSCL is on in SSS2RET1.

The fields represent counts for the single data set returned if SSS2TYPE is SSS2PUGE. The fields represent the total for all data sets selected if SSS2TYPE is SSS2COUN.

For a SAPI PUT/GET request, these field values are for the single returned data set. For a SAPI COUNT request, these values represent the sum of all the data sets that have been selected for the count, not taking individual copies requested of these data sets into effect.
SSS2LNCT
Output field

Line count

For a PUT/GET request, this value is for the single returned data set. For a COUNT request, this value represents the sum of all the data sets that have been selected for the count, not taking individual copies requested of these data sets into effect.

SSS2PGCT
Output field

Page count

For a PUT/GET request, this value is for the single returned data set. For a COUNT request, this value represents the sum of all the data sets that have been selected for the count, not taking individual copies requested of these data sets into effect.

SSS2BYCT
Output field

Byte count after blank truncation

For a PUT/GET request, this value is for the single returned data set. For a COUNT request, JES2 does not return this value. Meanwhile, for JES3 this value represents the sum of all the data sets that have been selected for the count, not taking individual copies requested of these data sets into effect.

SSS2RCCT
Output field

Spool record count (JES3 only)

For a PUT/GET request, this value is for the single returned data set. For a COUNT request, this value represents the sum of all the data sets that have been selected in the count, not taking individual copies of these data sets into effect.

SSS2PRCD
Output field

Procname for the step creating this data set

SSS2STPD
Output field

Stepname for the step creating this data set

SSS2DDND
Output field

DDNAME for the data set creation

SSS2SWBT
Output field

Token used for SJFREQ services. This field is filled in if flag SSS2FSWB is set.

See PUT/GET Requests for programming considerations concerning the use of the SSS2SWBT field.

SSS2SWTU
Output field

Address of the SWBTU block. This field is filled in if flag SSS2FSWT or SSS2FSWB is set.

See PUT/GET Requests for programming considerations concerning the use of the SSS2SWTU field.

SSS2PRIV
Input/Output field

Copied to and from SAPPRIV if JES2, COWPRIV if JES3.

SSS2CHR1
Output field

Printer translate table 1

SSS2CHR2
Output field

Printer translate table 2

SSS2CHR3
Output field

Printer translate table 3

SSS2CHR4
Output field

Printer translate table 4

SSS2OGNM
Output field

JES2 output group name

The data set returned with a given output group name will not necessarily continue to have the given output group name if this request keeps the data set.

This field is valid only if SSS2GNVA is on in SSS2RET1.

SSS2RMOD
Output field

Printer copy modify image

SSS2MODT
Output field

Printer table reference character

SSS2RFLS
Output field

Printer flash cartridge ID

SSS2FLSC
Output field

Number of flash copies

SSS2PRIO
Output field

Data set priority

SSS2LINC
Output field

Lines/page (JES2 only)

SSS2TOD
Output field

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

SSS2CDS
Output field

Count of work units (JOEs/OSEs) that match the selection criteria.

SSS2NJED
Output field

Address of NJE data set header. This field is non-zero if a data set header is available and the SSS2NJEH flag is on.

SSS2FCBR
Output field

Forms control buffer (FCB). Set to asterisks ('****') if the default FCB is returned.

SSS2UCSR
Output field

Universal character set (UCS). Set to asterisks ('****') if the default UCS is returned.

SSS2DSTR
Output field

Address of a token that can be used in a subsequent PUTGET call (SSS2PUGE in SSS2TYPE) to get the same data set. SSS2DSTR is filled in by JES after the token is constructed. After processing the data set, JES constructs the data set token in storage controlled by JES. JES then moves the address of the token into the field, SSS2DSTR. JES then returns the IAZSSS2 parameter list to the application. To have the token available for use on a refetch, the user must save the entire token in storage controlled by the user. When re-fetching the data set, SSS2CTKN must point to the entire saved token and SSS2SCTK bit must be turned on in flag, SSS2SEL5. Note that the token has a length defined by the field, CTKNSIZE, in IAZCTKN.

SSS2WSI
The Work Selection Identifier assigned to each SYSOUT data set (JES3 only):
  • 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 are assigned the same value.
  • The assigned values are unique to the job and cannot be used across jobs.
  • The value of the identifier does not affect the order of returned data sets.
SSS2DSNM
Data set number (key) of the returned data set.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014