Previous Topic: Installation RequirementsNext Topic: Generated Output


Coding Syntax

somevarname = OPSVASRV(“function [supporting keywords]”)

Refer to the Sample Coding Statements for specific syntax details of each of these listed functions and keywords. Valid function options:

function

Function Description

CREATE

Creates a single variable with specific attributes and a value as defined within the supporting NAME, DATAVAR or DATAVAL keywords.

DECR

Decrement a single variable that was created as a DATATYPE(SIGNED32) type, by a numeric value that is specified in the supporting DATAVAL or DATAVAR keywords.

DELETE

Delete a single variable as specified within the supporting NAME keyword.

DELLIKE

Delete all variables matching a name mask as specified within the supporting NAME keyword.

GET

Retrieve the value of a single variable as specified within the supporting NAME keyword.

GETNEXT

Retrieve the value of the next variable matching a variable name mask as specified within the supporting NAME and TOKEN keywords.

GETLIKE

Read the variables that match a name mask as specified within the supporting NAME keyword and return the list of variable names, values, and attributes. The OPTIONS keyword can be used to select or limit the data that is returned.

INCR

Increment a single variable that was created as a DATATYPE(SIGNED32) type, by a numeric value that is specified in the supporting DATAVAL or DATAVAR keywords.

PURGE

Purge/Delete all sysplex variables created by the same CA OPS/MVS sub system across all sysplex systems.

SWAP

Update a variable as a compare and swap instruction utilizing the new value as specified with the DATAVAL or DATAVAR keywords and current value as specified with the CURVAL or CURVAR keywords.

UPDATE

Updates an existing single variable as specified by the supporting NAME keyword with a value as defined by the supporting DATAVAL or DATAVAR keywords.

Note: The UPDATE function creates the target variable automatically, using the NAME keyword, if the variable was not previously defined. The variable typeis STRING and the DATAVAL or DATAVAR value specified is assigned to the new variable.

Valid [supporting keywords]:

Supporting keyword

Keyword Description

NAME(Variable name or mask)

Specify the name or name mask of the sysplex variable you want to access. The variable name that you specify must begin with the sysplex variable stem value GLVPLXTx, where x=A-Z or 0-9. Like OPSVALUE, A-Z can fire CA OPS/MVS AOF Global Variable Rules (GLV) rules for value changes. The 0-9 suffix never fires GLV rules. The maximum character length is 128 characters. Name lengths less than 80 characters are recommended. Required keyword for CREATE,DELLIKE,GETLIKE,and GETNEXT functions

DATAVAL(‘new data value’)

Defines the new data literal value that is to be assigned to the specified variable. For the variable values containing non character or complex character strings such as mixed quotation marks, utilize the DATAVAR keyword instead of this DATAVAL keyword.

DATAVAR(variable name)

Defines the new data literal value that is to be assigned to the specified variable using the name of a simple variable created within the application (supported AOF rule, OPS/REXX program,TSO/E REXX)

DATATYPE(data type)

Defines the type of the variable data. Valid data types are:

  • STRING

A Text string

  • SIGNED32

32-bit signed integer

  • XML

An XML document

  • UNDEF

Undefined

Default: UNDEF

If DATATYPE is specified on the CREATE function it is required on the UPDATE function.

CURVAL(current data value)

Specify the current value of the variable. This keyword is only available when using the SWAP function.

CURVAR(variable name)

Simple variable name that contains the current value of the variable. This keyword is only available when using the SWAP function.

OPTIONS(option1,option2,...)

Provide additional processing options for specific functions. Valid options are:

  • STATS

Include variable name metadata that is associated with variable names returned by the GETLIKE, GET, and GETNEXT request. STATS is a default value for GETNEXT.

  • SUBNAME

Perform z/OS system symbol substitution on the variable name specified within the NAME keyword.

  • NOVALUES

When used with the GETLIKE, GET, and GETNEXT function, do not return the variable value data for each variable.

  • NOSYNCUPDT

Prevents waiting for the variable operation to complete. Treats the sysplex variable request as asynchronous and always returns RC=0, RSN=0 even if the request fails.

GROUP(group name)

Specify a name to associate variables by an application or component name. Group name must be 16 characters or less.

DELAY(number of secs)

The DELAY keyword indicates the number of seconds that your OPSVASRV request waits before it can be processed. The default is 0; you can specify any number of seconds from 1 to 300. Delay is ignored when executing in an AOF rule.

PREFIX(output variable prefix)

Optionally specify the stem name that is to be used for any returned output variables

SUBSYS(ssid)

The CA OPS/MVS subsystem name that is to execute the specified function. This keyword is only needed when multiple copies of CA OPS/MVS exist and the function is to occur on a specific CA OPS/MVS subsystem.

TOKEN(token id number)

Identifies the next internally stored variable that is to be obtained via the GETNEXT function. This token id would have been obtained by a previously issued GET function.