UPDATE

Update an existing CICSPlex® SM or CICS® definition.

Read syntax diagramSkip visual syntax diagramUPDATEOBJECT(data-value) FROM(data-area)RESULT(cpsm-token)MODIFY(data-area)LENGTH(data-value) PARM(data-area)PARMLEN(data-value)CONTEXT(data-value)SCOPE(data-value)THREAD(cpsm-token) RESPONSE(data-ref) REASON(data-ref)

Description

This command updates an existing CICSPlex SM or CICS definition according to the attribute values you specify.
  • The updated definition replaces the existing definition in the CICSPlex SM data repository.
  • For definitions that have a CICSplex as their context (such as workload management or real-time analysis definitions), the definition is also updated in the data repositories of all CMASs involved in managing the CICSplex.

Related commands

CREATE, REMOVE

Options

CONTEXT(data-value)
Identifies the context for this command. The context must be the 1- to 8-character name of a CMAS or CICSplex.

If you do not specify the CONTEXT option, the default context for the thread is assumed.

FROM(data-area)
Identifies a buffer containing a resource table record that represents the definition to be updated.

The record must include all of the attributes for the resource table specified on the OBJECT option. For optional attributes that you do not want to specify, set the field to null (that is, zero) values .

LENGTH(data-value)
A fullword value that specifies the length of the FROM or MODIFY buffer.
Note: The buffer length you specify should not include any data other than a resource table record or modification expression.
MODIFY(data-area)
Identifies a buffer containing the modification expression to be used in modifying CICS Definition resource table records.

For details on how to form a modification expression, see Developing CICSPlex SM applications.

OBJECT(data-value)
Identifies the resource table that represents the definition being updated. This value must be the 8-character name of a valid CPSM Definition or CICS Definition resource table. For a list of the CICSPlex SM resource tables by type, see Developing CICSPlex SM applications.
PARM(data-area)
Identifies a buffer containing a parameter expression to be used in updating the definition.

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

PARMLEN(data-value)
A fullword value that specifies the length of the PARM buffer.
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 must contain CICS Definition resource table records. The records are updated according to the modification expression you supply in the MODIFY buffer.
The result set can be one produced by any of these commands:
  • COPY
  • GET
  • GROUP
  • PERFORM OBJECT.
SCOPE(data-value)
Identifies the scope for this command.

If the current context (as set by this command or a previous CONNECT or QUALIFY command) is a CICSplex and the OBJECT option identifies a CICS definitional resource and the PARM option includes the CSD parameter, a valid scope can be specified.

The scope can be a CICS system within the CICSplex. If the current context is a CMAS or the OBJECT option identifies any other type of resource table, or the CSD parameter is not specified on a CICS definitional resource, this option has no meaning and is ignored.

If SCOPE applies to the command and you do not specify the SCOPE option, the default scope for the thread is assumed. If the current context is a CICSplex and no default scope has been set on a CONNECT or QUALIFY command, you receive an INVALIDPARM response for the SCOPE option.

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.

Conditions

The following is a list of the RESPONSE values that can be returned by the UPDATE command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.
OK
The command completed processing successfully.
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
For CSD requests only, 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
An invalid data error occurred for one of the following reasons:
MODIFY
An attribute value listed in the MODIFY buffer is not valid for the specified attribute.
NOTSUPPORTED
An attribute listed in the MODIFY buffer is not modifiable.
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:
  • CONTEXT
  • FROM
  • LENGTH
  • MODIFY
  • OBJECT
  • PARM
  • PARMLEN
  • RESULT
  • THREAD.
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.
CSDAPI
Support for the CICSPlex SM API to access the CICS CSD is not available.
MAINTPOINT
The maintenance point for the current context is not available.
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 one of the following reasons:
DATAERROR
The value associated with one or more resource table attributes is invalid. This error can occur if:
  • The resource table is missing required attributes, contains one or more conflicting attributes, or does not exist.
  • A CICS resource definition contains attributes that would cause the EXEC CICS CREATE command to issue warnings.
Use the FEEDBACK command to retrieve additional data about this error.
INVALIDATTR
One of the resource table attributes is invalid.
INVALIDVER
The specified version of the resource table is not supported by CICSPlex SM.
VERSIONINVL
A version conflict occurred for one of the following reasons:
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.