Input disposition fields (optional)

These input disposition fields (optionally specified by the application thread) are used to determine what is to be done with the data set that was last returned to the application and that is now being disposed of. If this is the first SAPI PUT/GET call, then there is no "last" data set; therefore the following information is ignored.

Start of change Table 1 describes the SAPI disposition in SSS2 and the associated queue status options. End of change

Table 1. SAPI Disposition in SSS2
SAPI Disposition in SSS2	PROCESSED	HOLD	RELEASE
Field/Flag in SSS2	SSS2DKPE off	SSS2DKPE+ SSS2DHLD	SSS2DKPE+ SSS2DRLS	Queue based on resulting OUTDISP
SYSOUT OUTDISP:
Keep	Leave	Leave	Keep	On PRINT queue
Leave	Purge	Leave	Keep	On HOLD queue
Write	Purge	Hold	Write	On PRINT queue
Hold	Purge	Hold	Write	On HOLD queue

SSS2DSP1

Input field

Flags describing the disposition for the data set whose name is currently in SSS2DSN.

Settings in SSS2DSP1 and other dispositions are honored if and only if the keep bit (SSS2DKPE) is on. In JES3, the absence of the keep bit implies that the data set will be deleted.

In JES2, if SSS2DKPE is off and the data set has OUTDISP=KEEP, the data set will have OUTDISP=LEAVE after processing. If SSS2DKPE is off and the data set does not have OUTDISP=KEEP, the data set is deleted regardless of other disposition settings in this section.

SSS2DKPE

Keep the data set

SSS2RHLD

Keep the data set and make it non-selectable (system hold)

SSS2RNPR

Keep the data set and leave it selectable, but never return to this SAPI address space

SSS2RNPR on means that the JES does not return the data set to the application address space again. The application must treat this as a "suggestion" to the JES. The data set could be seen again by the application if:

The JES is restarted
The application is restarted
Some characteristic is changed by the operator or another application
Selection by token is requested.

SSS2DHLD

Hold the data set

This bit is mutually exclusive with SSS2DRLS.

SSS2DRLS

Release the data set

This bit is mutually exclusive with SSS2DHLD.

SSS2CHKP

Use SSS2RBA to checkpoint the data set position. The next data set returned will have SSS2DSF on. Refer to SSS2RBA for more information.

SSS2DNWR

Set writer name to a null value (all X'40's).

SSS2RNPT

Leave the data set selectable, but never return to this SYSOUT API thread again. The data set could be seen by the thread if:

The JES is restarted
Some characteristic is changed by the operator to another application
Selection by token is requested.

SSS2DSP2

Input field

Flags describing the disposition for the data set whose name is currently in SSS2DSN.

SSS2RPRI

Use the priority in SSS2DPRI.

SSS2DNFO

Set forms code to the installation default

SSS2REMV

Removes the data set from the current JOE.

Use this flag with SSS2CTK (select by client token) for a SAPI thread that will affect a single data set. Use this flag with a pair of PUT/GET calls, using SSS2CTK on the first call and CTRL on the second call. This is not restricted in the interface. Using this flag with other selection criteria can result in incorrect groupings. This specification is supported by JES2 only.

SSS2RENF

All ENF (event notification facility) signals are issued for the data set.

SSS2RENF is only valid for authorized callers and is ignored for unauthorized callers.

The following fields (SSS2DCLS, SSS2DFOR, SSS2DPGM, SSS2DDES, SSS2CLFT, and SSS2DPRI) are used to change a subset of the data set characteristics. These only have meaning if the data set is kept (SSS2DKPE on in SSS2DSP1).

A null value indicates that no override is desired for SSS2DCLS, SSS2DFOR, SSS2DPGM, SSS2DDES, and SSS2CLFT.

SSS2DCLS

Input field

New class.

SSS2DFOR

Input field

New forms.

SSS2DPGM

Input field

New user writer name.

SSS2DDES

Input field

New destination.

SSS2CLFT

Input field

Number of copies left to process. Values > 255 are treated as 255.

An SSS2CLFT specification interrupts the normal processing of a group of data sets, sets the copies left value for the selected data set, and suspends processing of the data sets in the group.

A SSS2CLFT specification 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 SSS2CLFT or SSS2RBA 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.

SSS2DPRI

Input field

New data set priority. A value of 0 through 255 is accepted. This field is meaningful only if SSS2RPRI is on in SSS2DSP2. This specification is supported by JES2 only.