GROUP

Description

Related commands

• DISCARD
• EXPAND
• FETCH
• GET
• LOCATE
• MARK
• ORDER
• QUERY
• SPECIFY FILTER

Options

ALL

Summarizes all the resource table records in the source result set.

BY(data-value)

Identifies the resource table attribute whose value is to be used as the grouping factor for this operation. This value must be the 1- to 12-character name of a valid attribute for the resource table.

COUNT(data-ref)

Names a variable to receive the number of resource table records in the target result set after this operation is complete.

FILTER(cpsm-token)

Identifies a filter to be used for this operation. The FILTER option summarizes only those resource table records that meet the specified filter criteria.

The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.

FROM(cpsm-token)

Identifies the source result set for this operation. The result set can be one produced by any of these commands:

• COPY
• GET
• PERFORM OBJECT

Note: If you discard the source result set, all of the summarized result sets that were created from it are also discarded.

LENGTH(data-value)

A fullword value that specifies the length of the SUMOPT buffer.

Note: The buffer length you specify should not include any data other than a summary expression.

MARKED

Summarizes only those resource table records that are marked in the source result set. You can mark resource table records by using the MARK and UNMARK commands.

NOTFILTER(cpsm-token)

Identifies a filter to be used for this operation. The NOTFILTER option summarizes only those resource table records that do not meet the specified filter criteria.

The cpsm-token value that identifies a filter is returned by the SPECIFY FILTER command.

NOTMARKED

Summarizes only those resource table records that are not marked in the source result set. You can mark resource table records by using the MARK and UNMARK commands.

REASON(data-ref)

Names a variable to receive the fullword reason value returned by this command.

RESPONSE(data-ref)

Names a variable to receive the fullword response value returned by this command.

SUMOPT(data-area)

Identifies a buffer containing the summary expression to be used for this operation. The SUMOPT value overrides the default summary options for the resource table attributes.

For details on how to form a summary expression, see Developing CICSPlex SM applications. For a list of the default summary options for a given resource table, see CICSPlex SM resource tables.

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.

TO(cpsm-token)

Identifies the target result set for this operation.

If this field is set to binary zero (in COBOL, C, PL/I or Assembler) or an uninitialized variable (in REXX), CICSPlex® SM creates a new summarized result set and returns its identifying token in the same field.

Otherwise, you can specify an existing summarized result that was produced by a previous GROUP command against the result set specified in the FROM option. That is, you can reuse a summarized result set, but only to resummarize the records in the same result set.

Note: If you specify the token of a previously produced summarized result set, make sure the result set still exists. When you discard a source result set, all of the summarized result sets that were created from it are also discarded.

Conditions