PERFORM SET

Perform an action on one or more resources.

Read syntax diagramSkip visual syntax diagramPERFORMSETACTION(data-value)ALLCURRENTFILTER(cpsm-token)MARKEDNOTFILTER(cpsm-token)NOTMARKEDPOSITION(data-value)NOREFRESHNOWAITTOKEN(data-value)PARM(data-area)PARMLEN(data-value)RESULT(cpsm-token)THREAD(cpsm-token)RESPONSE(data-ref)REASON(data-ref)

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

The following is a list of the RESPONSE values that can be returned by the PERFORM SET command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.
OK
The command completed processing successfully.
SCHEDULED
The command has been scheduled for processing.
NODATA
No records were found that matched the specified search criteria. If the ALL option was specified, the following reason may be returned:
FORWARD
There are no more records that satisfy the search criteria in the forward direction.
BUSY
A busy condition occurred for the following reason:
RESULT
The result set specified on the RESULT option is being processed by another command.
ENVIRONERROR
An environment error occurred for one of the following reasons:
NOSERVICE
The application stub program could not load the API service module.
NOSTORAGE
The application stub program could not obtain the necessary storage in the address space where the processing thread is running.
NOTPROCESSED
One of the MASs to which the request was directed could not process the request.
REQTIMEOUT
One of the CMASs or MASs to which the request was directed did not respond.
SOCRESOURCE
A required resource that is owned by the CMAS is not available.
FAILED
The command failed for one of the following reasons:
ABENDED
Command processing abended.
EXCEPTION
Command processing encountered an exceptional condition.
INVALIDATA
Invalid data was detected. The parameter that contains invalid data is returned as the reason value:
PARM
An attribute value listed in the PARM buffer is not valid for the specified attribute.
INVALIDCMD
The command is invalid for the following reason:
LENGTH
The total length of all the options on the command exceeds the maximum limit.
INVALIDPARM
An invalid parameter was detected. The parameter that is invalid is returned as the reason value:
  • ACTION
  • FILTER
  • NOTFILTER
  • PARM
  • PARMLEN
  • POSITION
  • RESULT
  • THREAD
  • TOKEN.
Check the command description for valid parameter syntax.
NOTAVAILABLE
A not available condition occurred for one of the following reasons:
APITASK
The API control subtask is not active.
CMAS
A CMAS to which the request was directed is not available.
CPSMAPI
The CMAS to which the processing thread is connected is not available for API processing.
MAINTPOINT
The maintenance point for the current context is not available.
PLEXMGR
The CMAS to which the processing thread is currently connected does not participate in managing the specified CICSplex and no other CMAS is available that does manage the CICSplex.
SCOPE
At least one of the MASs in the specified scope is unavailable
WORKLOAD
The workload identified on the API request is not available on the local CMAS.
NOTFOUND
A not found condition occurred for one of the following reasons:
ACTION
The action specified on the ACTION option was not found for the specified resource table.
ATTRIBUTE
An attribute specified in the CRITERIA or PARM buffer was not found for the specified resource table.
NOTPERMIT
A not permitted condition occurred for the following reason:
USRID
The user ID associated with the processing thread does not have the required security authorization.
SERVERGONE
The CMAS to which the processing thread was connected is no longer active.
TABLEERROR
A resource table record is invalid for the following reason:
DATAERROR
The value associated with one or more resource table attributes is invalid. This error can occur if the resource table is missing required fields, contains one or more conflicting fields, or is a duplicate. For BAS this error can also occur if you do not have the required security authorization. Use the FEEDBACK command to retrieve additional data about this error.
VERSIONINVL
A version conflict occurred for one of the following reasons:
ACTION
The specified action is not supported for the version used with the CONNECT command.
NOTSUPPORTED
The version of the application stub program used for this command is not supported.
NOTVSNCONN
The version of the application stub program used for this command is not the same as the version used with the CONNECT command.