Input-only fields (Optional)

These fields, designated ‘Optional Input-Only Fields’, are used for the application to convey certain information about the particular call to the JES. Individual fields are set depending on the particular SAPI call being made at the time. Although these fields are designated ‘optional’, they must be set properly to effect the desired result of any particular SAPI request. For example, if the application thread needs to be posted when available work appears on the queue matching the selection criteria, then optional input field SSS2ECBP must have been set with the address of the caller-supplied ECB.

SSS2APPL

For application use.

Either leave as binary zeros or supply an EBCDIC value that can be used for display purposes should you wish to view the SSS2 if performing diagnostics. An example might be to uniquely identify a particular thread's SSS2 in a storage dump.

SSS2APL1

For application use

SSS2ECBP

Input field

Address of an ECB to be POSTed when work is available satisfying the selection criteria. The ECB is POSTed only if a prior PUT/GET request has returned with a reason code of SSS2EODS. The ECB is provided by the user.

The caller is allowed to free the memory for this ECB only after making a call with SSS2CTRL on in SSS2MSC1.

SSS2RBA

Input/Output field

Relative byte address (RBA) of first record to be read.

Only valid if bit SSS2CHKP is on.

An SSS2RBA specification, with the attendant SSS2CHKP bit, interrupts the normal processing of a group of data sets, sets the RBA for the selected data set, and suspends processing of the data sets in the group. Processing continues with the next eligible group of data sets.

A SSS2RBA specification, with the attendant SSS2CHKP bit, is intended to be used by applications to interrupt the normal processing of a group of data sets, and to defer processing to a later time or terminate the thread.

JES2 only: if SSS2RBA or SSS2CLFT is the only change specified, SSS2RNPT, SSS2RNPR, and SSS2RHLD, if specified, will be applied to the current and remaining data sets in the output group. If there are changes to other characteristics of the data set that would result in the removal of the data set from the group, the remaining data sets in the group will not be affected by SSS2RNPT, SSS2RNPR, and SSS2RHLD specifications, and thus will be eligible for re-selection.

SSS2UFLG

Input field

Specifies the modification processing to occur to the selected data sets.

SSS2UFLG is meaningful only if SSS2BULK is specified in SSS2TYPE (that is, this is a SAPI BULK MODIFY call).

SSS2SETC: Use SSS2CLAS as the new class
SSS2DELC: Delete selected data set(s)
SSS2ROUT: Use SSS2DES2 as the new data set destination
SSS2RLSE: Release selected data sets

SSS2SEL1

Input field

Used for selection of new data sets.

You can specify selection from one, two, or three queues. The order of output with respect to the writer queues and with respect to held and non-held state is not predictable.

SSS2SHLD: Select "HOLD/LEAVE" output (JES2); select "hold for TSO" output (JES3)
SSS2SXWH: Select "hold for XWTR". In a JES2 environment, this has the same meaning as SSS2SHLD.
SSS2SHOL: Select from the hold queue. Specifying this setting guarantees that held output is returned regardless of the JES servicing this request.
SSS2SWTR: Select "WRITE/KEEP" output (JES2); select from the writer queue if JES3. If none of the three bits are set, then the request is handled as if SSS2SWTR was specified.
SSS2SAWT: Select from all the above
SSS2SCLS: Use SSS2CLSL as the class selection list
SSS2SDST: Use SSS2DEST as a filter
SSS2SJBN: Use SSS2JOBN as a filter
SSS2SDUP: Use SSS2JOBN as a filter, but give a reason code of SSS2DUPJ if duplicate jobs. This setting is meaningful only if SSS2JOBN has no wildcard characters. The setting is not used for a bulk modify (SSS2BULK) or count (SSS2COUN) request.
SSS2SDU2: Give a reason code of SSS2DUPJ if duplicate job. This setting is only meaningful if SSS2JOBN is also set.
SSS2SJBI: Use SSS2JBIL and SSS2JBIH as filters

SSS2SEL2

Input field

Used for selection of new data sets.

SSS2SPGM: Use SSS2PGMN as a filter
SSS2SFRM: Use SSS2FORM as a filter
SSS2SCRE: Use SSS2CREA as a filter
SSS2SPRM: Use SSS2PRMO as a filter
SSS2SIPA: Only select output that has an Internet Protocol (IP) address
SSS2SIPN: Only select output that has no IP address. This setting is mutually exclusive with SSS2SIPA
SSS2SFCB: Use SSS2FCB as a filter
SSS2SUCS: Use SSS2UCS as a filter

SSS2SEL3

Input field

Used for selection of new data sets.

SSS2SSTC: Select Started Tasks (STCs) (see note in SSS2STYP)
SSS2STSU: Select Time Sharing Users (TSUs) (see note in SSS2STYP)
SSS2SJOB: Select batch jobs (JOBs) (see note in SSS2STYP)
SSS2SAPC: Select APPC output (see note in SSS2STYP)
SSS2STYP: If none of these bits is on, then selection is as if all of the bits are on.

SSS2SEL4

Input field

Used for selection of new data sets.

SSS2SMOD: Use SSS2MOD as a filter
SSS2SFLS: Use SSS2FLSH as a filter
SSS2SAGE: Data sets selected must be at least as old as the value in SSS2AGE.
SSS2SLIN: Use minimum and maximum line counts specified in SSS2LMIN and SSS2LMAX as a data set group filter
SSS2SPAG: Use minimum and maximum page counts specified in SSS2PMIN and SSS2PMAX as a data set group filter
SSS2SPRI: Select output based on priority
SSS2SVOL: Select output based on the volume serial list in SSS2VOL (SSS2NVOL in SSS2RET2 on if the JES does not support)
SSS2SCHR: Use Printer translation tables in SSS2CHAR as a filter (SSS2NCHR in SSS2RET2 on if the JES does not support)

SSS2SEL5

Input field

Used for selection of new data sets.

SSS2SCPN

Select data set having no CPDS.

SSS2SCTK

Select by client token. Mutually exclusive with SSS2SJBI. You can use this filter as the only input or in conjunction with additional filters. If you use other filters, they must all match the SYSOUT attributes.

SSS2SBRO

Use SAPI as a "browse" facility rather than a "processing" facility.

SSS2SODS

Use SSS2ODST as a filter.

SSS2SRON

SSS2SRON indicates that this is a non-update type selection and denotes that the application intent is read-only.

If this bit is on, JES will perform READ access requests for the data sets selected and give an error return code if an attempt is made to update the status of a data set that was obtained with read access. The error will cause the current thread to be terminated.

The indicators SSS2RNPT (do not show to thread again) and SSS2RNPR (do not show to address space again) will be honored for non-update type calls.

The default SAF access for SAPI requests is UPDATE in the JESSPOOL class. Specifying SSS2SRON means that the application guarantees that no modification of the data sets will be attempted and thus READ access to the JESSPOOL class is all that is required. If the application attempts to modify the data sets in any way other than setting SSS2RNPT (do not show to thread again) or setting SSS2RNPR (do not show to this address space again), the thread will be terminated with return code of SSS2BDIS in SSOBRETN and a reason code of SSS2RRON in SSS2REAS. SSS2SRON applies to PUTGET requests only.

SSS2SENL

SSS2SENL is used with SSS2SLIN.

If this bit is on, JES2 will enforce the use of minimum and maximum line counts specified in SSS2LMIN and SSS2LMAX as a data set group filter for data sets with a line count of zero. The default logic for JES2 work selection is to ignore line limits when the data sets have a line count of zero.

SSS2SENP

SSS2SENP is used with SSS2SPAG.

If this bit is on, JES2 will enforce the use of minimum and maximum page counts specified in SSS2PMIN and SSS2PMAX as a data set group filter for data sets with a page count of zero. The default logic for JES2 work selection is to ignore page limits when the data sets have a page count of zero.

SSS2SEL6

Input field

Used for selection of new data sets.

SSS2STPN

Transaction job name filtering.

If this bit is on, SYSOUT associated with a transaction job name that matches SSS2JOBN is selected. In addition, SYSOUT that is owned by a job that matches SSS2JOBN is also returned.

The SSS2STPN bit is ignored if one of the following situations occurs:

SSS2SJBN or SSS2SDUP is not set.
JES2 is used but JES2 is not running with checkpoint mode z11.

SSS2STPI

Transaction ID filtering.

If this bit is on, SYSOUT associated with a transaction job id in the range specified by SSS2JBIL and SSS2JBIH are selected. In addition, SYSOUT that is owned by a job that has a job id in this range is also returned.

The SSS2STPI bit is ignored if one of the following situations occurs:

SSS2SJBI is not set.
JES2 is used but JES2 is not running with checkpoint mode z11.

SSS2SIG0

Ignore line and page limits if corresponding actual line and page counts for the data set are zero (if SSS2SENL and SSS2SENP are off).

SSS2MSC1

Processing flags

SSS2CTRL

On: Processing complete. JES disassociates all its held resources on behalf of the calling thread.
Off: Normal processing is to occur depending on the value of the SSS2TYPE field (that is, a SAPI PUT/GET, SAPI COUNT, or SAPI BULK MODIFY call).

SSS2FSWB

Return token for SJFREQ calls in field SSS2SWBT. This also means that the address of the SWBTUREQ buffer is returned in field SSS2SWTU

SSS2FSWT

Return address of SWBTUREQ buffer in field SSS2SWTU

SSS2NJEH

Return address of NJE data set and job headers if available (SSS2NJED for data set header; SSS2NJEJ for job header) (SSS2NNHD in SSS2RET2 on if the JES does not support)

SSS2JOBN

Input field

Used for selection of new data sets. Supports wildcards.

Jobname used for selection (if SSS2SJBN on)

To influence the type of job selected, use the settings in SSS2SEL3.

SSS2JBIL

Input field

Used for selection of new data sets. Low jobid used for selection (if SSS2SJBI is on).

When SSS2JBIL is 2-8 characters and starts with one of the prefixes ’J’, ’JO’, ’JOB’, or '*', then the suffix is converted to a binary value. Job IDs with a suffix matching the SSS2JBIL suffix are returned. Embedded and trailing blanks are acceptable. The maximum length of the jobid is eight characters.

When SSS2JBIL contains 1-8 character with one or more generic characters '*' and '?', and EBCDIC characters A-Z; 0-9; or national characters @, #, $, then job IDs, as returned in SSS2JBIR, that match a 1-8 character EBCDIC comparison with SSS2JBIL are returned. A single character SSS2JBIL with '*' or '?' is not allowed. SSS2JBIH must be blank.

When SSS2STPI is set and SSS2JBIL is 2-8 characters starting with the prefix '*', then the suffix is converted to a binary value. Transaction job IDs with a suffix matching the SSS2JBIL suffix are also returned.

When SSS2STPI is set and SSS2JBIL contains 1-8 EBCDIC character A-Z; 0-9; national characters @, #, $; or generic characters '*' and '?', then transaction job IDs that match a 1-8 character EBCDIC comparison with SSS2JBIL are also returned. A single character SSS2JBIL with '*' or '? is not allowed. When generic characters are used, SSS2JBIH must be blank.

To influence the type of job selected, use the settings in SSS2SEL3.

In a JES2 environment, for STCs and TSUs, the jobid must be passed in the format of xxxnnnnn where xxx is JOB, JO, or J, or the format of xxxnnnnn where xxx is JO, J0, or J.

SSS2JBIH

Input field

Used for selection of new data sets.

High jobid used for selection (if SSS2SJBI on). This value must be null or at least as high as SSS2JBIL.

When SSS2JBIH is 2-8 characters and starts with one of the prefixes ’J’, ’JO’, ’JOB’, then the suffix is converted to a binary value. Job IDs with a suffix within the range from the SSS2JBIL suffix through the SSS2JBIH suffix are returned. Generics characters '*' or '?' are not allowed. Embedded and trailing blanks are acceptable. The maximum length of the jobid is eight characters.

When SSS2STPI is set, EBCDIC characters A-Z; 0-9; and national characters @, #, $ are allowed. Job IDs, as returned in STTRJID, and transaction job IDs within the 1-8 character EBCDIC range from SSS2JBIL through SSS2JBIH, are returned. Generics characters '*' or '?' are not allowed.

The following table describes examples of jobs returned for SSS2JBIL when SSS2JBIH is blank. Numeric matches are in normal font, EBCDIC matches are in italicized font.

SSS2CREA

Input field

Used for selection of new data sets. Supports wildcards.

Creator user ID used for selection (if SSS2SCRE on).

SSS2PRMO

Input field

One to four values used for selection of new data sets. Supports wildcards.

One to four PRMODEs used for selection (if SSS2SPRM is on).

This list must contain null entries (X'40's) for any of the elements not containing a selection parameter.

SSS2DEST

Input field

Used for selection of new data sets. Supports wildcards.

In JES2, the user ID portion of the destination can contain the generic characters "*" and "?". This can match SYSOUT with a route code that contains a corresponding user ID routing. However, destinations of the format "R*", "RM*", "RMT*", "U*", and "N*" will not match SYSOUT with a route code of remote, special local, local, anylocal, or NJE. Also, wildcards are not supported for destinations defined by DESTID initialization statements. For more information, see the topic on Controlling JES2 Processes in z/OS JES2 Initialization and Tuning Reference.

Destination value used for selection (if SSS2SDST on).

SSS2DES2

Input field

Specifies the new destination of data sets selected for bulk modify requests.

New destination if SSS2ROUT is on.

SSS2PGMN

Input field

Used for selection of new data sets. Supports wildcards.

User writer name used for selection (if SSS2SPGM is on).

SSS2FORM

Input field

One to eight values used for selection of new data sets. Supports wildcards.

One to eight form numbers used for selection (if SSS2SFRM is on).

This list must contain null entries (X'40's) for any of the elements not containing a selection parameter.

SSS2CLSL

Input field

Used for selection of new data sets.

SYSOUT class list used for selection (if SSS2SCLS is on). List is terminated by X'40'.

If multiple classes are listed for the initial PUT/GET request, JES searches all data sets for the first class specified before searching for the second class specified, and so on until all classes have been searched.

For JES3 only, due to searching algorithms, it is suggested that an application thread, if using multiple SYSOUT classes in SSS2CLSL, set the value to the single, returned class (from SSS2CLAR) after a data set is returned from a SAPI PUT/GET call if the application thread wishes additional data sets of this class to be returned. This prevents JES3 from excessive queue searches. After the SSOBRETN value of SSS2EODS has been returned, the application can then re-supply SSS2CLSL with the original, multi-class list to continue to search for additional data sets on subsequent SAPI PUT/GET calls.

SSS2CLAS

Input field

Specifies the new class for data sets modified through bulk modify.

New class if SSS2SETC is on.

SSS2LMIN

Input field

Used for selection of new data sets.

The minimum number of lines (records) generated by an output group must not fall below this value if SSS2SLIN is set on, if JES2 is to consider the output group selectable. JES2 checks record limits if the data set is in line mode.

SSS2LMAX

Input field

Used for selection of new data sets.

The maximum number of lines (records) generated by an output group must not exceed this value if SSS2SLIN is on, if JES2 is to consider the output group selectable. JES2 checks record limits if the data set is in line mode.

SSS2PMIN

Input field

Used for selection of new data sets.

The minimum number of pages generated by an output group must not fall below this value if SSS2SPAG is set on , if JES2 is to consider the output group selectable. JES2 checks the page limits (SSS2PMIN and SSS2PMAX) if the data set is in page mode. If the page data set contains some line mode data, then JES2 checks both page limits and record limits (SSS2LMIN and SSS2LMAX).

SSS2PMAX

Input field

Used for selection of new data sets.

The maximum number of pages generated by an output group must not exceed this value if SSS2SPAG is set on , if JES2 is to consider the output group selectable. JES2 checks the page limits (SSS2PMIN and SSS2PMAX) if the data set is in page mode. If the page data set contains some line mode data, then JES2 checks both page limits and record limits (SSS2LMIN and SSS2LMAX).

SSS2FCB

Input field

Used for selection of new data sets.

FCB image name used for selection (if SSS2SFCB is on)

SSS2UCS

Input field

Used for selection of new data sets.

UCS image name used for selection (if SSS2SUCS is on)

SSS2CHAR

Input field

One to four values used to select new data sets (JES3 only).

One to four printer translate tables used for selection (if SSS2SCHR is on).

This list must contain null entries (X'40's) for any of the elements not containing a selection parameter.

SSS2MOD

Input field

Used for selection of new data sets.

Modify image used for selection (if SSS2SMOD is on)

SSS2FLSH

Input field

Used for selection of new data sets.

Flash cartridge ID for selection (if SSS2SFLH is on)

SSS2SECT

Input field

Used for selection of new data sets.

Address of the security token or zero. If the application thread provides the address of the token to be returned, then the application thread must set the length in the first byte of the area, and the version in the second byte of the area prior to issuing the SAPI PUT/GET call.

SSS2AGE

Input field

Used for selection of new data sets.

Minimum age of data sets to be selected (if SSS2SAGE is on). The low order bit represents 1.048576 seconds (that is, the high order word of the TOD clock).

SSS2VOL

Input field

One to four values used to select new data sets (JES2 only).

One to four SPOOL volume serial numbers. Jobs are selected if and only if the job has output on at least one of the volumes listed and SSS2SVOL is on.

This list must contain null entries (X'40's) for any of the elements not containing a selection parameter.

SSS2CTKN

Input field

Address of client token used for selection (if SSS2SCTK is on).

Mutually exclusive with SSS2SJBI.

SSS2ODST

Input field

Specifies the eight-character origination node name from which the job was submitted.

Valid only if SSS2SODS in SSS2SEL5 is on.