>>-FETCH--INTO(data-area)--LENGTH(data-ref)---------------------> >--+-+-----------------------+--+----------------------+-+------> | +-FILTER(cpsm-token)----+ '-CICSNAME(data-value)-' | | '-NOTFILTER(cpsm-token)-' | +-ALL-------------------------------------------------+ +-MARKED----------------------------------------------+ '-NOTMARKED-------------------------------------------' .-DATA---. >--+----------------------+--+-----------------+--+--------+----> '-POSITION(data-value)-' '-COUNT(data-ref)-' +-BOTH---+ '-STATUS-' .-FORWARD--. >--+--------------------------+--+----------+-------------------> '-DETAIL--+--------------+-' '-BACKWARD-' '-APPLYSUMMARY-' >--RESULT(cpsm-token)--THREAD(cpsm-token)--RESPONSE(data-ref)---> >--REASON(data-ref)--------------------------------------------><
This command retrieves data and status information for one or more resource table records in a result set.
COPY, GET, GETDEF, GROUP, LOCATE, MARK, ORDER, PERFORM OBJECT, QUERY, SPECIFY FILTER
If the DETAIL option is specified without the APPLYSUMMARY option the result will be as described under the DETAIL option.
If neither the DETAIL option nor the APPLYSUMMARY option are specified but any combination of some or all of the following record selection options: MARKED, NOTMARKED, FILTER, and NOTFILTER are issued against a summary result set, the record selection options are applied to the summary result set and the selected summary records are retrieved.
The CICSNAME option indicates that only those resource table records that originate from CICS systems that match the specified name pattern should be considered for retrieval. When CICSNAME is specified in conjunction with FILTER or NOTFILTER, only records which meet the FILTER or NOTFILTER requirements and also match the CICSNAME pattern will be considered. The number of records actually retrieved is determined by the COUNT option.
When you specify CICSNAME, the result set named on the RESULT option must not be a summarized result set and must contain resource table records that have an EYU_CICSNAME attribute. If the result set specifed by RESULT contains summarized records or resource table records that do not have an EYU_CICSNAME attribute, you receive an INVALIDPARM response for the CICSNAME option.
The COUNT option applies to the result set named in the RESULT option. When you also specify the DETAIL option, COUNT provides the number of summary records in the summarized result set in RESULT for which source records are returned. The OBJSTAT table for each summary record contains the number of source records that will be returned for that record if the DETAIL option is specified.
If you do not specify the COUNT option, the default is one.
If the COUNT option is specified, COUNT contains the number of records processed. In most cases this is also the number of records returned. However, if you also specify the DETAIL option, all source records associated with the requested number of summary record are retrieved. This is normally greater than the number specified in the COUNT option.
If you are retrieving multiple records, they are placed one after another in the INTO buffer. The INTO buffer should be long enough to hold all the records being retrieved.
The value that CICSPlex SM returns in this field depends on the RESPONSE value for the FETCH command as follows:
When you specify DETAIL, the result set named in the RESULT option must be a summarized result set. DETAIL expands the summary record by retrieving the resource table records associated with it from the source result set. If you do not specify DETAIL when a summarized result set is being processed, the summary records themselves are retrieved. If the result set is not a summarized result set, this option has no meaning and is ignored.
You can use the FORWARD or BACKWARD options along with DETAIL to select which summary record you want to expand. The FORWARD and BACKWARD options also control the direction in which records are retrieve from the source result set.
By default, all the source records associated with the summary record or records are retrieved. However, you can use the FILTER or NOTFILTER option to limit the records retrieved from the source result set. You can also use the MARKED or NOTMARKED option to retrieve only those records associated with the summary record that are marked (or not marked) in the source result set.
You cannot explicitly position the record pointer in the source result set. When you specify DETAIL, the POSITION option refers to the record in the summary result set. If the APPLYSUMMARY option is specified, FILTER, NOTFILTER, MARKED, and NOTMARKED options are applied to records in the summary result set rather than to the source records.
For more information on processing summarized result sets, see CICSPlex® System Manager Application Programming Guide. For a description of the GROUP command, which creates summarized result sets, see GROUP.
The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.
The value that CICSPlex SM returns in this field depends on the RESPONSE value for the FETCH command:
You can mark resource table records by using the MARK and UNMARK commands.
The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.
You can mark resource table records by using the MARK and UNMARK commands.
This value must be a number that identifies the record’s relative position in the result set. The first record in a result set is identified by the number 1.
For example, to begin the retrieval process with the fifth resource table record in a result set, you would specify POSITION(5).
The following is a list of the RESPONSE values that can be returned by the FETCH command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.