Commands

The REXX-specific commands supplied with CICSPlex® SM perform a series of API commands internally and return the results to REXX.

The commands are presented here in alphabetical order. Each description includes the purpose, syntax, and available options for the command.

Notes:
  1. You cannot use these commands to process user-defined views of a resource table that were created by the SPECIFY VIEW command. If you create a view with the same name as a supplied resource table and then specify that name on one of these commands, the command fails.
  2. These commands do not use the RESPONSE and REASON options. The result of these REXX-specific processes is returned by the STATUS option.
  3. These commands do not provide any useful FEEDBACK information. The API commands that are issued internally reuse the same feedback area. So, when one of these commands finishes processing, the feedback area does not represent the entire sequence of events.

The commands are:

TBUILD

Build a resource table record from a set of variables.

Read syntax diagramSkip visual syntax diagram>>-TBUILD--OBJECT(data-value)--PREFIX(data-value)--------------->
 
>--STATUS(data-ref)--VAR(data-area)--+------+------------------->
                                     '-ASIS-'
 
>--THREAD(cpsm-token)------------------------------------------><
 

Description

This command builds a resource table record from a set of variables that represent the individual attributes of a CICSPlex SM or CICS® definition. A definition is represented by a resource table with a type of CPSM Definition or CICS Definition.

You form the attribute variables by adding a prefix to the attribute name, like this:

  prefix_attribute

where prefix is a text string that you supply and attribute is the name of an attribute in the resource table. You must insert an underscore character (_) between the prefix and the attribute name.

The resource table record can be placed in any valid REXX variable, including a stem variable.

TBUILD only uses the attributes that you specify; it does not assume any default values for optional attributes. If you do not supply a variable for an attribute that is optional, the corresponding field in the resource table record is initialized according to its data type (that is, character fields are set to blanks, binary data and EYUDA values are set to zeroes).

Note:
For a list of the CICSPlex SM resource tables by type, see CICSPlex System Manager Application Programming Guide. For a complete description of a particular resource table and its attributes, see the CICSPlex System Manager Resource Tables Reference.

Options

ASIS
Indicates that the resource table attribute values are already in their internal format; they are to be processed as is, rather than translated.

You must use the ASIS option to rebuild a CICSPlex SM or CICS definition that you previously parsed (with the TPARSE ASIS command).

OBJECT(data-value)
Identifies the resource table for which a record is to be built. This value must be the 1- to 8-character name of a valid CPSM Definition or CICS Definition resource table.
Note:
You cannot use the TBUILD command to process a resource table view that was created by the SPECIFY VIEW command. If you create a view with the same name as a supplied resource table and then specify that name on a TBUILD command, the command fails.
PREFIX(data-value)
Specifies the prefix you used to name the variables that contain the resource table attributes.
Note:
The maximum allowable length for a prefix is determined by REXX and the environment in which the program runs.
STATUS(data-ref)
Names a variable to receive the REXX status value returned for this command. The status is returned in character form as one of the following:
OK
The TBUILD command completed processing successfully.
SYNTAX ERROR
The TBUILD command could not be processed because of a syntax error. EYUARnnnn messages that describe the error are written to the destination defined on your system for IRXSAY WRITEERR output.
FAILURE
The TBUILD command failed because some of the data it was attempting to process is invalid. Trace data is written to a REXX stem variable called EYUTRACE. EYUARnnnn messages that describe the failure may also be written to the destination defined on your system for IRXSAY WRITEERR output.
Note:
For more information about the EYUTRACE stem variable, see CICSPlex System Manager Application Programming Guide.
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.
VAR(data-area)
Names a variable to receive the resource table record that is built by TBUILD.

TPARSE

Parse a resource table record from a variable into a set of variables.

Read syntax diagramSkip visual syntax diagram>>-TPARSE--OBJECT(data-value)--PREFIX(data-value)--------------->
 
>--STATUS(data-ref)--VAR(data-area)--+------+------------------->
                                     '-ASIS-'
 
>--THREAD(cpsm-token)------------------------------------------><
 

Description

This command parses a resource table record from a variable into a set of variables that represent the individual attributes of the table. You can use TPARSE with any type of CICSPlex SM resource table.

The resource table variable can be any valid REXX variable, including a stem variable. The output variables are formed by adding a prefix to the attribute name, like this:

  prefix_attribute

where prefix is a text string that you supply and attribute is the name of an attribute in the resource table. An underscore (_) is inserted between the prefix and the attribute name.

Note:
For complete descriptions of the resource tables and their attributes, see the CICSPlex System Manager Resource Tables Reference.

Options

ASIS
Specifies that the resource table attribute values are not to be translated into their external format; they are to be returned as is. Attribute values are presented as follows:
  • Character values have trailing blanks.
  • Binary values have leading zeroes and are not converted to display format.
  • EYUDA and CVDA values are not converted to character format.
You must use the ASIS option to parse a CPSM Definition or CICS Definition resource table that you want to rebuild (with the TBUILD ASIS command).
Note:
If you use the ASIS option with EYUDA or CVDA values, you can use the TRANSLATE command to convert the coded numeric value into a character value.
OBJECT(data-value)
Identifies the resource table that is to be parsed. This value must be the 1- to 8-character name of a valid resource table.
Note:
You cannot use the TPARSE command to process a resource table view that was created by the SPECIFY VIEW command. If you create a view with the same name as a supplied resource table and then specify that name on a PARSE command, the command fails.
PREFIX(data-value)
Specifies the prefix you want to use to name the attribute variables returned by TPARSE.
Note:
The maximum allowable length for a prefix is determined by REXX and the environment in which the program runs.
STATUS(data-ref)
Names a variable to receive the REXX status value returned for this command. The status is returned in character form as one of the following:
OK
The TPARSE command completed processing successfully.
SYNTAX ERROR
The TPARSE command could not be processed because of a syntax error. EYUARnnnn messages that describe the error are written to the destination defined on your system for IRXSAY WRITEERR output.
FAILURE
The TPARSE command failed because some of the data it was attempting to process is invalid. Trace data is written to a REXX stem variable called EYUTRACE. EYUARnnnn messages that describe the failure may also be written to the destination defined on your system for IRXSAY WRITEERR output.
Note:
For more information about the EYUTRACE stem variable, see CICSPlex System Manager Application Programming Guide.
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.
VAR(data-area)
Names a variable that contains the resource table record to be parsed.
[[ Contents Previous Page | Next Page Index ]]