Input Parameters

Input parameters for the function routine are:

SSOB
SSIB
SSSF

SSOB Contents: The caller sets the following fields in the SSOB control block on input:

Field Name: Description
SSOBID: Identifier 'SSOB'
SSOBLEN: Length of the SSOB (SSOBHSIZ) control block
SSOBFUNC: SSI function code 70 (SSOBSFS)
SSOBSSIB: Address of an SSIB control block or zero (if this field is zero, the life-of-job SSIB is used). See Subsystem Identification Block (SSIB) for more information on the life-of-job SSIB.
SSOBINDV: Address of the function dependent area (SSSF control block)

Set all other fields in the SSOB control block to binary zeros before issuing the IEFSSREQ macro.

SSIB Contents: If you don't use the life-of-job SSIB, the caller must provide an SSIB and set 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 to which this Scheduler Facilities call is directed. It is usually the primary JES, or in the case of JES2, a possible secondary JES. If your routine has not been initiated from such a JES, the caller must issue a Request Job ID call (SSI function code 20) prior to this scheduler facilities call. You must use the same subsystem name in this SSIBSSNM field as you used for the Request Job ID call.

The caller must set all other fields in the SSIB control block to binary zeros before issuing the IEFSSREQ macro.

SSSF Contents: The caller must set the following fields in the IAZSSSF control block on input to a Scheduler Facilities call:

Field Name

Description

SSSFID

Control block eyecatcher, set to 'SSSF'.

SSSFLEN

Length of the SSSF control block. The length is the sum of the header length size, SSSFHSZE, and the size of the request dependent area. For the SWB modify function, the size of the request dependent area is SSSFMRSZ. For the SWB merge and SWB cleanup functions, the size of the request dependent area is SSSFFMSZ.

SSFVER

Version of mapping for the caller – Set this field to SSSFCVER (an IBM-defined integer constant within the SSSF control block).

SSSFREQF

Function request value – designates the function type requested. Possible values are:

SSSFSWBM: SWB modify of output descriptors
SSSFSWBF: SWB merge of output descriptors
SSSFSWBC: Return storage used for SWB merge function. Use this function when all SWB merge calls are finished. The format of the SSOB extension is identical to that used for the SSSFSWBF function.

Set all other fields in the SSSF control block to binary zeros before issuing the IEFSSREQ macro.

The following section describes the sub-function dependent area for the SWB modify subfunction. The caller must set the following fields in the IAZSSSF control block on input to the SWB modify subfunction.

For the SWB modify function, the caller can optionally set the following fields in the IAZSSSF control block on input to the scheduler facilities call.

SSSFFLG1

Flag Byte - request dependent indicator.

For the SWB modify function, this flag indicates the type of security authorization checking requested for this request. Note that only one of the following two flags should be turned on.

SSSFDEST: Perform a destination check. This check ensures that the user has SAF authority to the ISFAUTH resource (JES2 only).
SSSFSECL: Perform a SECLABEL dominance check to ensure that the SECLABEL of the user dominates the SECLABEL of the SYSOUT. This request is honored for authorized callers, and the authorization check will be performed only if the appropriate security environment exists (JES2 only).

If neither of the above values has been specified in SSSFFLG1 for the SWB modify function, the default security authorization check ensures that the user has SAF authority to the JESSPOOL resource.

SSSFMTYP: Indicates the type of modify data is being passed. OFF means that individual job identification data is being passed (JES2 only). ON indicates that a client token is being passed.

The following fields should be filled in when bit SSSFMTYP in SSSFFLG1 is OFF.

SSSFJBNM: The 1-8 character jobname associated with the sysout that is to be modified.
SSSFJBID: The 1-8 character jobid associated with the sysout that is to be modified.
SSSFGRPN: The 1-8 character output group name associated with the sysout that is to be modified.
SSSFGRP1: Output group id 1 associated with the sysout that is to be modified.
SSSFGRP2: Output group id 2 associated with the sysout that is to be modified.

The following field should be filled in when bit SSSFMTYP in SSSFFLG1 is ON.

SSSFMDST

Address of client token. The token is either a data set level token for JES3 or a group level token for JES2.

A data set level token is returned in field STVSCTKN when a verbose output request is made using SSI 80 (Extended Status). In addition, the address of a data set token is returned in field SSS2DSTR for each data set returned by SSI 79 (SAPI). (JES3 only)

A client token is returned by the DYNALLOC macro. The text unit DALRTCTK (key 0071) will return an 80 byte JES Client Token as the data of the text unit.

JES3 requires the use of SSSFMDST.

The following fields are common to all types of modify requests.

SSSFCART

The 1-8 character command and response token (CART) to be used for WTO responses. (JES2 only)

SSSFCNID

The console identifier to be used for WTO responses. (JES2 only)

SSSFMDAD

Address of output descriptor modify list in SWBTU format. This list is mapped as follows:

SJPRFX area, mapped by macro IEFSJPFX. Note that field SJPRVERB should be set to 'OUTPUT' to indicate that this is an OUTPUT descriptor.
Area for text units. See macro IEFDOTUM for a mapping of each text unit.

For the SWB modify function, the caller must set at least one of the following two pairs of fields in the IAZSSSF control block to be non-zero on input to the scheduler facilities call. The pairs are:

Pair 1: SSSFMDAD and SSSFMDLN
Pair 2: SSSFERAD and SSSFERLN

Within a pair, both fields must be non-zero (for example, if the user just wants the 'erase' function in pair 2, then SSSFERAD and SSSFERLN must be non-zero). The user can choose to fill in pair 1, pair 2, or both pairs.

SSSFMDLN

Length of modify list – includes length of prefix area.

SSSFERAD

Address of output descriptor Erase list in TU format. The erase list is a list of fullword fields, each of which consists of a two byte key value, (defined in macro IEFDOKEY), and two bytes of zeroes.

Pair 1: SSSFMDAD and SSSFMDLN
Pair 2: SSSFERAD and SSSFERLN

SSSFERLN

Length of erase list.

For the SWB modify function, the caller can optionally set the following fields in the IAZSSSF control block on input to the scheduler facilities call.

SSSFFLG1

Flag Byte – request dependent indicator.

For the SWB modify function, this flag indicates the type of security authorization checking requested for this request. Note that only one flag should be turned on.

SSSFDEST: Perform a destination check. This check ensures that the user has SAF authority to the ISFAUTH resource (SDSF class).
SSSFSECL: Perform a SECLABEL dominance check to ensure that the SECLABEL of the user dominates the SECLABEL of the SYSOUT. This request is honored for authorized callers, and the authorization check will be performed only if the appropriate security environment exists.

If no value has been specified in SSSFFLG1 for the SWB modify function, the default security authorization check will ensure that the user has SAF authority to the JESSPOOL resource.

SSSFCART

The 1-8 character command and response token (CART) to be used for WTO responses.

SSSFCNID

The console identifier to be used for WTO responses.

The following section describes the sub-function dependent area for the SWB merge subfunction. The caller must set the following fields in the IAZSSSF control block on input to the SWB merge subfunction.

SSSFFDTK: Address of the data set token representing the data set. The dataset token can be obtained, for example, from SSI function code 80 (STVSCTKN) or SSI function code 79 (SSS2DSTR).

For the SWB merge function, the caller can optionally set the following fields in the IAZSSSF control block on input to the scheduler facilities call.

SSSFFGTK

Address of a group token representing the data set. This is an optional value. If given, it must be the address of the group token. The group token is in field STSTCTKN returned by SSI Function Code 80. (JES2 only)

SSSFFLG1

Flag Byte - request dependent indicator.

SSSFFSWB: Provide non-SWA SWBs in addition to SWBTUs.
SSSFCPAT: Return compatibility SWBs.