PERFORM SET

Description

This command performs an action on one or more resources as represented by resource table records in an existing result set. If the context and scope in effect when you issue a PERFORM SET command include CICS® systems that do not support the requested action, the request is ignored for those CICS systems.

Related commands

• LOCATE
• MARK
• PERFORM OBJECT
• SET
• SPECIFY FILTER

Options

ACTION(data-value)

Identifies the action to be performed. This value must be the 1- to 12-character name of a valid action for the resource table.

For a description of the actions that are valid for a given resource table, see CICSPlex SM resource tables.

ALL

Performs the specified action against all the resource table records in the result set.

CURRENT

Performs the specified action against only the current resource table record.

FILTER(cpsm-token)

Identifies a filter to be used for this operation. The FILTER option performs the action against only those resource table records that meet the specified filter criteria.

The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.

MARKED

Performs the specified action against only those resource table records that are marked in the result set. You can mark resource table records by using the MARK and UNMARK commands.

NOREFRESH

Specifies that the resource table records in the source result set should not be refreshed. The records reflect the status of the resources before the PERFORM SET command was processed.

If you do not specify the NOREFRESH option, the resource table records are refreshed to reflect the resource status after this operation is complete.

NOTFILTER(cpsm-token)

Identifies a filter to be used for this operation. The NOTFILTER option performs the action against only those resource table records that do not meet the specified filter criteria.

The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.

NOTMARKED

Performs the specified action against only those resource table records that are not marked in the result set. You can mark resource table records by using the MARK and UNMARK commands.

NOWAIT

Returns control to your program as soon as the PERFORM SET command has been accepted, which allows the command to be processed asynchronously.

If you specify the NOWAIT option, you must use a subsequent RECEIVE command to test for the completion of this request. The results of an asynchronous request are returned as ASYNCREQ resource table records. For a complete description of asynchronous processing, see Developing CICSPlex SM applications.

Note: If you specify the TOKEN option, the NOWAIT option is assumed by default.

PARM(data-area)

Identifies a buffer containing the parameter expression to be used in performing the action.

For details on how to use a parameter expression with the PERFORM SET command, see Developing CICSPlex SM applications. For a description of the parameters that are required for a given resource table action, see CICSPlex SM resource tables.

PARMLEN(data-value)

A fullword value that specifies the length of the PARM buffer.

POSITION(data-value)

Performs the specified action against the nth resource table record in the result set.

This value must be a number that identifies the record's relative position in the result set. The first record in a result set is identified by the number 1.

For example, to perform the specified action on the fifth resource table record in a result set, you would specify POSITION(5).

REASON(data-ref)

Names a variable to receive the fullword reason value returned by this command.

RESPONSE(data-ref)

Names a variable to receive the fullword response value returned by this command.

RESULT(cpsm-token)

Identifies the API result set to be processed by this operation. The result set can be one produced by any of these commands:

• COPY
• GET
• GROUP
• PERFORM OBJECT

THREAD(cpsm-token)

Identifies the API thread to be used for this operation. The cpsm-token value that identifies a thread is returned by the CONNECT command.

TOKEN(data-value)

Defines a 1- to 4-character token that you choose to correlate an asynchronous PERFORM SET request with the result of a subsequent RECEIVE command. This token is for use by your program; CICSPlex® SM makes no use of the value. The token is returned by the RECEIVE command when this PERFORM SET request is complete.

Conditions