POI Command Processors › OPSSETV Command Processor—Create or Update Global Variable Values

OPSSETV Command Processor—Create or Update Global Variable Values

The OPSSETV command processor creates a global variable or updates the value of a global variable.

You can either update the whole variable or only a substring portion of the variable.

The TOKEN keyword provides for a serialized fetch and update sequence in which an intervening update is detected.

This command has the following format:

OPSSETV
Specify the following two required keywords in the order shown:
{varname}
{(varvalue)}
[CMDRESP(TERMINAL|NOWHERE)]
[DELAY(0,seconds)]
[OFFSET(displacement)]
[SUBSYS(OPSS,ssid)]
[SVRULES(YES|NO)]
[SYSTEM(msfids|ALL|EXT)]
[SYSWAIT(seconds)]
[TOKEN(nn)]
[UPPERCASE(YES|NO)]

varname

Specify the complete name of the global variable that you want to create or update with a new value. This keyword must precede the varvalue keyword.

You can specify an unprefixed (Automate-format) variable name as the value of varname. The CA OPS/MVS product determines the appropriate stem prefix internally using the ATMLOCALSCOPEnn and ATMSHAREDSCOPEnn parameters.

varvalue

Specify the value that you want to assign to varname. This keyword must follow the varname keyword.

CMDRESP

(Optional) Indicates how CA OPS/MVS should handle the response from OPSSETV. Values are:

TERMINAL

(Default) Displays the response at the terminal.

NOWHERE

Tells CA OPS/MVS that it should not issue any messages except error messages. This option is provided to eliminate messages in REXX programs.

When you invoke your OPSSETV request as a TSO command, the default of CMDRESP is CMDRESP(TERMINAL).

When you invoke your OPSSETV request as an OPS/REXX or TSO/E REXX function, the default of CMDRESP is CMDRESP(NOWHERE).

DELAY

(Optional) Indicates the number of seconds that your OPSSETV request waits before it can be processed. You can specify any number of seconds from 1 to 300.

Default: 0

OFFSET

(Optional) Indicates the substring displacement, relative to 1, at which the variable value is to be placed. The length of the substring is the length of the new variable value. Undefined areas of a new or updated variable are padded with blanks.

Default: 1

SUBSYS

(Optional) For more information on the SUBSYS keyword, see Specifying a Subsystem ID on a POI Command Processor in this chapter.

SVRULES

(Optional) Indicates whether you want the status variable that OPSSETV sets to be processed by global variable rules. Values are:

YES

(Default) Indicates that you want rules to process the status variable.

NO

Indicates that you do not want rules to process the status variable.

SYSTEM

(Optional) For more information on the SYSTEM keyword, see Specifying an MSF System ID on a POI Command Processor in this chapter.

Note: If more than one system is specified or implied, and the local system is one of the systems that receives the request, CA OPS/MVS returns only the result for the local system.

SYSWAIT

(Optional) For a cross-system request, the SYSWAIT keyword specifies the number of seconds that CA OPS/MVS should wait for the remote system to receive and respond to the OPSSETV request. You can specify any number of seconds from 1 to 600.

Default: The value of the MSFSYSWAIT parameter.

TOKEN

(Optional) Use the TOKEN keyword if you want to update a variable only after verifying its current value.

For the value of nn, specify a token that is equal to the current value of the update counter of the variable. You can use the OPSGETV command processor to obtain a current value of the variable as well as the value of its update counter. The update counter of a new variable has a value of 0. The update counter value that OPSGETV returns is the value you should specify for TOKEN(nn).

Before CA OPS/MVS performs the update, it tries to match the value you specify for TOKEN(nn) against the current update count of the variable to ensure that the value of the variable has not changed since the time you obtained it using OPSGETV. If the values do not match, CA OPS/MVS does not perform the update.

The TOKEN keyword provides a serialization facility that is similar to the one provided by the compare and update facility of the OPSVALUE function.

There is no default.

UPPERCASE

(Optional) Determines whether the variable value specified is converted to uppercase characters.

Default: YES