DATA/GET
Request the CICSPlex® SM Web User Interface server to create a result set of records that satisfy a query.
Description
Initially, you issue a DATA/GET request for a new result set of records without specifying a STUB option on the command. The response from the server includes a STUB header identifying the result set.
You can reuse a results set by issuing a another DATA/GET command that specifies a previous stub value. This has the effect of discarding the old results and reusing the resources to hold the results of the new DATA/GET request.
The result of a DATA/GET command for STATUS OK is shown in Table 1.
| Header field | Description |
|---|---|
| COUNT= | The number of records in the results set that match the query. This can be a zero value. |
| OBJECT= | The CICSPlex SM resource name, as specified on the DATA/GET command. |
| REASON= | The CICSPlex SM API reason code, where applicable. |
| RESPONSE= | The CICSPlex SM API response code. |
| STUB= | The stub value to be used for the next request relating to this query. This can be another GET, or a FETCH or DISCARD command. |
| USERID= | The user ID signed on to the Web User Interface Server session used for this request. |
The CICSPlex SM Web User Interface server manages each active data interface result set as a single-user session window. Each user session can have at anyone time a maximum of 64 active windows, which are shared between the client application data interface and the HTML interface.
Data: The DATA/GET command does not return any data records after the response header fields. The command creates a result set from which a subsequent DATA/FETCH command can retrieve records.
Options
- A_attributeName=value
- Specifies the value of a known attribute name from one of the CICSPlex SM resource tables. For example, if your
query is to find all the disabled files using the LOCFILE resource table, the keyword
A_attributeName becomes A_ENABLESTATUS and the operand is DISABLED. The following attribute datatypes can be used as filters:
- AVG
- AVG3
- BIN
- CHAR
- CODEBIN
- CVDAS
- CVDAT
- DEC
- EYUDA
- HEX
- INTVSTCK
- PCT
- PCT3
- RATE
- RATE3
- SCLOCK
- SCLOCK12
- SUM
- SUM3
See Providing access to WUI views and menus for a discussion about selection criteria and Data representation for information about data representation.
- CONTEXT=value
- Specifies the context for resources that use the CICSplex name. The context must be the 1- to
8-character name of a CICSplex.
If you omit this option, the server uses the last CONTEXT for the specified STUB, or the server default if you do not specify a STUB on the command.
- CMASCONTEXT=value
- Specifies the context for resources that use the CMAS name.
If you omit this option, the server uses the last CMASCONTEXT for the specified STUB, or the server default if you do not specify a STUB on the command.
- O_attributeName=value
- Specifies the filter operator to be used with a known attribute name from one of the CICSPlex SM resource tables. For a list of the operator values for the O_attrname query variable and their meanings, see Selection criteria. For example, if your GET query is about the enable status of files in the LOCFILE resource table, the result of A_ENABLESTATUS=DISABLED with O_ENABLESTATUS=NE is all the files that are in ENABLED, UNENABLED, and DISABLING state (that is, all those that are not DISABLED).
- OBJECT=value
- Specifies the name of the CICSPlex SM resource table in which A_attributeName is a valid attribute. This option is required, and must specify the 1- to 8-character name of either a valid resource table or a valid view.
- P_parameterName=value
- Specifies a parameter filter for the resources. For example, P_WORKLOAD=name in the
WLMAWAOR resource table, where name is the name of an active workload..
Not all resources have parameters associated with them. See Data representation for information about data representation.
- SCOPE=value
- Specifies the scope for those resources that require a scope.
- STUB=value
- Specifies the result set stub value returned by the server in response to an earlier request.
This is optional, and has the following effect:
- If you omit the STUB option, the server creates a new result set. If the server has created one or more result sets from previous requests, these are preserved and unaffected by this request.
- If you specify the STUB option, the server reuses the old result set storage for the new query. In effect, issuing a DATA/GET request with a stub value is the equivalent of issuing a DATA/DISCARD followed by a DATA/GET, and avoids tying up system resources that are no longer needed.
Note: Your client application can use a stub value received from Web User Interface server once only. Once you specify a stub value on a request to a Web User Interface server, you cannot use the same value again.
STATUS values
- BADATTR
- An A_attribueName keyword is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
- BADCOMMAND
- The command passed to the data interface by the Web User Interface is not recognized.
- BADOBJECT
- The value specified on the OBJECT option is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
- BADPARM
- A P_parameterName keyword is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
- BADSTUB
- The stub value is not valid for the request. This could be for one of the following reasons:
- You have specified a stub value that does not belong to the user session on which you have issued the command.
- The stub value is out of sequence.
- BUSYSTUB
- The Web User Interface server is still processing a previous request for this stub.
- CMASGONE
- The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.
- MAXWIN
- The maximum number of windows (64) for the user session has been reached.