Function

To specify the work selection and processing characteristics of one or more indicated offload SYSOUT transmitters.

One or more parameters on this command accepts wild cards. Parameter descriptions will note that.

Parameters

n [-m | *]

The subscript defining the offload SYSOUT transmitters that are affected by this command. The subscript can specify a single numeric value n (1-8) or a range of values n-m (1-8) associating offload SYSOUT transmitters with offload devices. The asterisk character (*) can be used to specify the first or last offload SYSOUT transmitter in a range (n-*, for example). A comma-delimited list of values or ranges is also supported. For details about specifying a range of values for this subscript, see Command syntax conventions.

Burst=[No|Yes]

The burst specification for this device that is considered as a work selection criterion, if Burst is also specified in the WS= list.

Y

Output that is to be bursted (page-separated) should be selected.

N

Output that is not to be bursted should be selected.

If the burst specification is not a criterion for output selection, specify a null parameter of (Burst=) and do not specify Burst in the WS= list.

CReator=creator

Specifies the 1 through 8 character userid that creates the SYSOUT data sets to be processed. You can also specify wild cards on this parameter. See Using wildcards for additional information.

j

An alphabetic character (A-Z) or any of the special characters ($, #, or @).

ccccccc

Any combination of EBCDIC characters except a comma, a right parenthesis, or an equal sign.

DISP={DELETE|HOLD|KEEP}

The disposition of all output that is selected for dumping to the offload data set.

DELETE

The output groups are purged after being dumped. A job is purged only if no more held or non-held output remains.

HOLD

Selected held output remains held after being dumped and is eligible for processing by another spool offload SYSOUT transmitter. Selected non-held output is marked non-selectable after being dumped and is not eligible for processing by another offload SYSOUT transmitter until their status is changed. You can change their status with the $TO command.

KEEP

The output groups retain their current status after being dumped. These output groups are eligible for processing by another spool offload SYSOUT transmitter.

FCB|C=fcb

The 1 to 4 alphanumeric or special ($ # @) character identifier of a particular forms control buffer image or carriage control tape. This characteristic is considered as a work selection criterion, if FCB is also specified in the WS= list. If the FCB characteristic is not a criterion for output selection, specify a null parameter of (FCB=) and do not specify FCB in the WS= list.

FLash|O=flash

The 1 to 4 alphanumeric or special ($ # @) character flash name for this device that is considered as a work selection criterion if FLash is also specified in the WS= list. If the FLash characteristic is not a criterion for output selection, specify a null parameter of (FLash=) and do not specify FLash in the WS= list.

Forms=form

The 1 to 8 alphanumeric or special ($ # @) character forms name for this device that is considered as a work selection criterion if Forms is also specified in the WS= list. You can also specify wild cards on this parameter. See Using wildcards for additional information. You may specify up to 8 forms.

If the Forms characteristic is not a criterion for output selection, specify a null parameter of (Forms=) and do not specify Forms in the WS= list.

Hold=[No|Yes]

The Hold specification for this device that is considered as a work selection criterion if Hold is also specified in the WS= list.

No

Only non-held post-execution jobs are to be selected.

Yes

Only held post-execution jobs are to be selected.

If both held and non-held jobs are to be selected, specify a null parameter of (Hold=) and do not specify Hold in the WS= list.

JOBname=jobname

A 1-8 character jobname that is considered as a work selection criterion, if JOBname is also specified in the WS= list. You can also specify wild cards on this parameter. See Using wildcards for additional information.

If the jobname is not a criterion for job selection, specify a null parameter of (JOBname=) and do not specify JOBname in the WS= list.

LIMit={m|m-n|m-*}

Specifies the limits (in records) set by this device for amount of output generated per output group. This range is considered as a work selection criterion if LIMit is also specified in the WS= list.

For both variables m and n, you can specify a range of values from 0-4294967295. m and n can be equal. If they are not equal, n must be larger than m.

If you code only m, that value becomes both the lower and upper limit. If m-* is specified, the upper limit is set to the default value of 4294967295.

NOTify={No|Yes}

Specifies whether a notification message is sent to the TSO userid specified on the JOB statement or /*NOTIFY JECL statement. If you specify ‘Y', a notification message is sent when all or part of a post-execution job is dumped to the offload data set. If you specify ‘N', no notification message is sent.

OUTDisp={H|HOLD|K|KEEP|L|LEAVE| W|WRITE}

Specifies the disposition(s) that the output must have in order to be eligible for processing by this offload transmitter. The operator can specify one to four of the following valid dispositions: Hold, Keep, Leave, or Write.

PLIM={m|m-n|m-*}

Specifies the limits (in pages) set by this device for amount of output generated per output group. This range is considered as a work selection criterion if PLIM is also specified in the WS= list.

For both variables m and n, you can specify a range of values from 0-4294967295. m and n can be equal. If they are not equal, n must be larger than m.

If you code only m, that value becomes both the lower and upper limit. If m-* is specified, the upper limit is set to the default value of 4294967295.

PRMode=(vvvvvvvv,vvvvvvvv,...)

Specifies the 1 to 8 alphanumeric character processing mode(s) to select for output. You can specify up to four process modes. You can also specify wild cards on this parameter. See Using wildcards for additional information.

If all processing modes are selectable, specify a null parameter of PRMODE=(). You must specify the empty parentheses.

Queue=queue

The only SYSOUT class(es) (A-Z, 0-9) that this device selects, if Queue is also specified in the WS= list. You may specify up to 36 classes. If the SYSOUT class is not a criterion for output selection, specify a null parameter of (Queue=) and do not specify Queue in the WS= list.

RANGE={Jnnnnn|Snnnnn|Tnnnnn} [-nnnnn]| J1–999999

The batch job (J), started task (S), or time sharing user (T) range specified for this device (1-999999). This range is considered as a work selection criterion if the RANGE parameter is also specified in the WS= list. If you code this parameter, you can specify one or two values:

• If you specify one value, that value becomes both the low and the high end of the range.
• If you specify two values, the first value is the low end of the range and the second value the high end. The two values can be equal. If they are not equal, the second value must be larger than the first value.

Routecde=routecde

Specifies the one to four destination selection criteria for which output can be selected. If more than one route code is specified, enclose the list in parentheses. The value for all routing numbers can range from 1 to 32767. You can also specify wild cards on this parameter. See Using wildcards for additional information. For specification requirements, see Route codes.

Note: NODENAME=REQUIRED on the DESTDEF initialization statement will cause JES2 to require that a userid be prefixed with a node name.

LOCAL|ANYLOCAL

Indicates that jobs are to be run at the local node.

destid

Indicates that jobs are to be run at the specified node(s). You can specify this location by an alias for the name of a node. If destid is specified alone, it refers to both the node and the remote.

Nnnnn|nodename

Indicates that jobs are to be run at the specified node(s). You can specify a node using the decimal node identifier or an EBCDIC nodename.

NnnnnRmmmm|node.remote|node.userid

Indicates routing to the remote Rmmmm at the node Nnnnn. Rmmmm can also be specified as RMmmmm or RMTmmmm.

Ummmm

Indicates special local routing.

node.destid

Indicates a destination at the specified node. The destid refers to both the node and the remote. The node specified in the destid must be the same as the node portion of the route code. If the number of the remote is reassigned, you can use the destid to send to this node.

remote

Indicates routing to a remote. Remote can be specified in any of the following ways:

LOCAL|ANYLOCAL

Indicates that jobs are to be run at the local node.

Rmmmm

Indicates routing to the specified remote. Rmmmm can also be specified as RMmmmm or RMTmmmm.

destid

Indicates routing to a destid referring to a remote.

userid

Indicates routing to a valid TSO userid, or a user* (where * means all local, remote, special local unit, and userid output at the specified node).

node.*

Indicates that the nodename is to be modified to the specified node name, but the remote node will remain the same.

If the route code is not a criterion for output selection, specify a null parameter of (Routecde=()) and do not specify Routecde in the WS= list. You must specify the empty parentheses.

T|UCS=ucs

The 1 to 4 character print train specification of this device. This print train is considered as a work selection criterion if UCS is also specified in the WS= list. If the UCS specification is not a criterion for output selection, specify a null parameter of (UCS=) and do not specify UCS in the WS= list.

Volume=volume

The volume serial (5-6 characters) of a volume containing a spool data set. If Volume is also specified in the WS= list, only the output of those jobs that reside on one or more of the specified volume(s) are selected by this device. You may specify up to 4 volumes. Multiple entries must be separated by commas and the list must be enclosed in parentheses.

If volume is not a criterion for output selection, specify a null parameter of (Volume=()) and do not specify Volume in the WS= list. You must specify the empty parentheses ().

Writer=writer

The 1 to 8 alphanumeric or special ($ # @) character writer name for this device. You can also specify wild cards on this parameter. See Using wildcards for additional information. A null parameter of Writer= specifies that this device has no writer name. If Writer is specified in the WS= list, only those data sets with matching writer name specifications can be selected.

WS=ws

Specifies the work selection criteria for this device. Using any combination of user and JES2-defined criteria, you can specify up to 19 criteria in the WS= list. Multiple entries must be separated by commas and the list must always be enclosed in parentheses (even if only one criterion is specified). If a criterion is specified in the list, work selection is based on the current setting of the corresponding parameter. If a criterion is not specified in the list, the criterion is not considered during work selection.

The general rules for specifying an offload SYSOUT transmitter work selection list are:

1. You can use one slash (/) before or after one of the criterion to further specify work selection. Criteria placed before the slash must be matched exactly if the work is to be selected. Criteria placed after the slash do not have to matched exactly except in the following cases:
   • PRMode
   • Queue
   • Routecde
   • Volume

   Table 1, describes the effect of each criterion when placed before and after the slash.

2. PRMode, Queue, Routecde, and Volume can be specified as multiple values on the offload SYSOUT transmitter initialization statement. Placing these criteria before the slash in the WS= list, indicates a left to right priority order of multiple values, if multiple values have been specified. Placing these criteria after the slash indicates no priority order of multiple values, but a match is still required.
3. The order of those criteria specified after the slash indicates the priority (highest to lowest, in left to right order) in which JES2 attempts to match them.
4. Specifying a minus sign (-) before a criterion causes that criterion to be removed from the list.
   Note: An invalid operand message ($HASP003) is issued if an error is found in the WS operand, that is, if you try to remove a criterion that is not there. For example: If you enter $toff1.st,ws=(-jobname) and jobname is not in the current work selection list for off1.st, you get the $HASP003 message.
5. Specifying a criterion that is not currently specified in the list adds it to the end of the list either before or after the slash, depending on the placement of the slash in the command. If the slash is omitted from the command, JES2 assumes that the slash is at the end of the command.
6. Specifying a criterion currently in the list causes that criterion to be moved to the end of the list, thereby decreasing its priority. To correct a WS list that was erroneously changed by an incorrect operator command, remove any criterion that should not be in the list (specify a minus sign (-) before the criterion). If necessary, reorder the remaining criterion.
7. The LIMit subparameter has no effect as a work selection value for files received from a node that does not provide a page count for its files. For more information, refer to the sending node's reference documentation.
8. In general, the smaller the work selection list the less the placement of certain criteria within the list affects the work selection.
9. For both line and page mode devices, the LIM= and PLIM= values must be satisfied.

Authority Required

This command requires system authority. The description of the $T RDRnn command explains how to ensure that the authority of the appropriate MVS™ system command group is assigned.

This command requires control security access authority. For a description of assigning command input authority, see z/OS JES2 Initialization and Tuning Guide, SA32-0991.

Processing Considerations

• If you specify a null value for a characteristic, make sure that characteristic is not specified as an exact match criterion in the work selection list. If the characteristic is specified as an exact match criterion, this device does not select any output.
• If you are uncertain of the characteristics in effect, enter the $D or $D U command for the particular offload SYSOUT transmitter.

Scope

Single member. The values supplied for this command will be in effect for this member only.

Depending on your installation's setup, however, you might want this command to be applied to all members of the MAS (to ensure a consistent environment across the MAS). If so, you can use the MVS ROUTE *ALL command to issue this command to all active members (if the JES2 command character is the same on all members). See z/OS MVS System Commands, SA38-0666 for more information on using the ROUTE *ALL command.

Messages

The $HASP886 message displays the current settings of all the parameters on the OFF(n).ST initialization statement.

Offload SYSOUT transmitter 1 offloads ready output in class a.