INQUIRE CAPTURESPEC

Retrieve information about a capture specification.

INQUIRE CAPTURESPEC

Conditions: END, ILLOGIC, INVREQ, NOTAUTH, NOTFND

This command is threadsafe.

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE CAPTURESPEC command returns the attributes associated with a capture specification.

Browsing

You can browse through all the deployed capture specifications installed in the specified event binding using the browse options (START, NEXT, and END) on INQUIRE CAPTURESPEC commands.

See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

CAPTUREPOINT(data-area)

Specifies a 25-character data area to receive the capture point associated with the capture specification. Its contents will match one of the capture point entries in the event binding tooling. Capture point entries consisting of two words or more are separated with an underscore; for example, LINK_PROGRAM or PROGRAM_INITIATION.

CAPTUREPTYPE(cvda)

Specifies a fullword binary data area to receive a CVDA value identifying the type of capture point. Possible CVDA values are as follows:

PRECOMMAND: Capture point is at the start of a CICS® API command.
POSTCOMMAND: Capture point is on completion of a CICS API command.
PROGRAMINIT: Capture point is at program initiation.
SYSTEM: Capture point is a system event.

CAPTURESPEC(data-area)

On the non-browse form of this command, specifies the name (1-32 characters) of the capture specification. On the browse form of this command, specifies a 32-character data area to receive the name of the capture specification.

CURRPGM(data-area)

Specifies an 8-character data area to receive the value specified by the application context predicate for the current program name. Blanks are returned if no application context predicate for the current program name is defined for this capture specification.

CURRPGMOP(cvda)

Returns a CVDA value that defines the operator that is used, together with the value in the CURRPGM option, to evaluate the application context predicate on the current program name. Possible CVDA values are as follows:

ALLVALUES: The predicate always evaluates true; that is, there is no filtering based on the name of the current program.
DOESNOTEQUAL: The predicate evaluates true when the name of the current program is not equal to the value of the CURRPGM option.
DOESNOTSTART: The predicate evaluates true when the name of the current program does not start with the value of the CURRPGM option.
EQUALS: The predicate evaluates true when the name of the current program is equal to the value of the CURRPGM option.
GREATERTHAN: The predicate evaluates true when the name of the current program is greater than the value of the CURRPGM option.
ISNOTGREATER: The predicate evaluates true when the name of the current program is equal to or less than the value of the CURRPGM option.
ISNOTLESS: The predicate evaluates true when the name of the current program is equal to or greater than the value of the CURRPGM option.
LESSTHAN: The predicate evaluates true when the name of the current program is less than the value of the CURRPGM option.
STARTSWITH: The predicate evaluates true when the name of the current program starts with the value of the CURRPGM option.

CURRTRANID(data-area)

Specifies a 4-character data area to receive the value specified by the application context predicate for the current transaction name.

CURRTRANIDOP(cvda)

Returns a CVDA value that defines the operator that is used, together with the value in the CURRTRANID option, to evaluate the application context predicate on the current transaction name. Possible CVDA values are as follows:

ALLVALUES: The predicate always evaluates true; that is, there is no filtering based on the name of the current transaction.
DOESNOTEQUAL: The predicate evaluates true when the name of the transaction that is running is not equal to the value of the CURRTRANID option.
DOESNOTSTART: The predicate evaluates true when the name of the transaction that is running does not start with the value of the CURRTRANID option.
EQUALS: The predicate evaluates true when the name of the current transaction is equal to the value of the CURRTRANID option.
GREATERTHAN: The predicate evaluates true when the name of the current transaction is greater (that is, higher in the collating sequence of possible transaction IDs) than the value of the CURRTRANID option.
ISNOTGREATER: The predicate evaluates true when the name of the current transaction is equal to or less (that is, lower in the collating sequence of possible transaction IDs) than the value of the CURRTRANID option.
ISNOTLESS: The predicate evaluates true when the name of the current transaction is equal to or greater (that is, higher in the collating sequence of possible transaction IDs) than the value of the CURRTRANID option.
LESSTHAN: The predicate evaluates true when the name of the current transaction is less (that is, lower in the collating sequence of possible transaction IDs) than the value of the CURRTRANID option.
STARTSWITH: The predicate evaluates true when the name of the current transaction starts with the value of the CURRTRANID option.

CURRUSERID(data-area)

Specifies an 8-character data area to receive the value specified by the application context predicate for the user ID that is associated with the current transaction.

CURRUSERIDOP(cvda)

Returns a CVDA value that defines the operator that is used, together with the value in the CURRUSERID option, to evaluate the application context predicate on the user ID. Possible CVDA values are as follows:

ALLVALUES: The predicate always evaluates true; that is, there is no filtering based on the user ID.
DOESNOTEQUAL: The predicate evaluates true when the user ID of the current user is not equal to the value of the CURRUSERID option.
DOESNOTSTART: The predicate evaluates true when the user ID of the current user does not start with the value of the CURRUSERID option.
EQUALS: The predicate evaluates true when the user ID of the current user is equal to the value of the CURRUSERID option.
GREATERTHAN: The predicate evaluates true when the user ID of the current user is greater (that is, higher in the collating sequence of possible user IDs) than the value of the CURRUSERID option.
ISNOTGREATER: The predicate evaluates true when the user ID of the current user is equal to or less (that is, lower in the collating sequence of possible user IDs) than the value of the CURRUSERID option.
ISNOTLESS: The predicate evaluates true when the user ID of the current user is equal to or greater (that is, higher in the collating sequence of possible user IDs) than the value of the CURRUSERID option.
LESSTHAN: The predicate evaluates true when the user ID of the current user is less (that is, lower in the collating sequence of possible user IDs) than the value of the CURRUSERID option.
STARTSWITH: The predicate evaluates true when the user ID of the current user starts with the value of the CURRUSERID option.

EVENTBINDING(data-value)

Specifies the name (1-32 characters) of the associated event binding.

EVENTNAME(data-area)

Specifies a 32-character data area to receive the associated business event name.

NUMDATAPRED(data-area)

Specifies a fullword binary field that is set to the number of application data predicates that are defined for this capture specification.

NUMINFOSRCE(data-area)

Specifies a fullword binary field that is set to the number of information sources that are defined for this capture specification.

NUMOPTPRED(data-area)

Specifies a fullword binary field that is set to the number of application command option or system event option predicates that are defined for this capture specification. The total number of predicates includes the primary predicate.

PRIMPRED(data-area)

Specifies a 32-character data area to receive the value of the primary predicate for this capture specification. The primary predicate for a capture specification is the predicate to specify with the EQUALS operator; it helps to avoid a performance impact as more capture specifications are added for a particular capture point. Blanks are returned if there is no named primary predicate defined for this capture point.

PRIMPREDOP(cvda)

Returns a CVDA value that defines the operator that is used, together with the value in the PRIMPRED option, to evaluate the primary predicate. Possible CVDA values are as follows:

ALLVALUES: The predicate always evaluates true; that is, there is no filtering based on the name of the resource for the command.
DOESNOTEQUAL: The predicate evaluates true when the resource that is specified by the command is not equal to the value of the PRIMPRED option.
DOESNOTSTART: The predicate evaluates true when the resource that is specified by the command does not start with the value of the PRIMPRED option.
EQUALS: The predicate evaluates true when the resource that is specified by the command is equal to the value of the PRIMPRED option.
GREATERTHAN: The predicate evaluates true when the resource that is specified by the command is greater than the value of the PRIMPRED option.
ISNOTGREATER: The predicate evaluates true when the resource that is specified by the command is equal to or less than the value of the PRIMPRED option.
ISNOTLESS: The predicate evaluates true when the resource specified by the command is equal to or greater than the value of the PRIMPRED option.
LESSTHAN: The predicate evaluates true when the resource that is specified by the command is less than the value of the PRIMPRED option.
STARTSWITH: The predicate evaluates true when the resource that is specified by the command starts with the value of the PRIMPRED option.

PRIMPREDTYPE(cvda)

Returns a CVDA value that identifies the type of the primary predicate for this capture specification. Possible CVDA values are as follows:

CONTAINER: The primary predicate is a container.
CURRENTPGM: The primary predicate is the current program name.
EVENT: The primary predicate is a CICS event.
FILE: The primary predicate is a CICS file.
MAP: The primary predicate is a CICS basic mapping support (BMS) map.
MESSAGEID: The primary predicate is a CICS or CPSM message id of form DFHxxnnnn or EYUxxnnnn.
NONE: The capture specification has no primary predicate.
PROGRAM: The primary predicate is a CICS program name.
SERVICE: The primary predicate is a CICS service or a WEBSERVICE resource.
TDQUEUE: The primary predicate is a CICS transient data queue.
TRANCLASS: The primary predicate is a CICS transaction class name.
TRANSACTION: The primary predicate is a CICS transaction identifier.
TSQUEUE: The primary predicate is a CICS temporary storage queue.

Conditions

END

RESP2 values:

2: There are no more resource definitions of this type.
8: The event binding has been deleted so browse has been terminated early.

ILLOGIC

RESP2 values:

1: You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.

INVREQ

4: An EVENTBINDING name has not been specified for the START CAPTURESPEC browse.

NOTAUTH

RESP2 values:

100: The user associated with the issuing task is not authorized to use this command.
101: The user associated with the issuing task is not authorized to read the event binding.

NOTFND

RESP2 values:

2: The specified capture specification cannot be found.
3: The specified event binding cannot be found.