INQUIRE EPADAPTER
Retrieve information about a specified event processing adapter.
Syntax
Warning: System commands are powerful as they
provide information about the state of the system and allow changes to be made to it. System
commands should be used only by authorized applications and users.
Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).
Conditions: END, ILLOGIC, NOTAUTH, NOTFND
NOHANDLE, RESP, and
RESP2 are common options that can be added to all EXEC CICS
commands to process error conditions. They are not explicitly included in the command syntax diagram
and option descriptions. For information about these common options and EXEC CICS
command syntax, see EXEC CICS command format and programming considerations. For more information
about the use of CVDAs, see CICS-value data areas (CVDAs).
This command is threadsafe.
Description
The INQUIRE EPADAPTER command returns information about a specified event processing adapter.
Browsing
You can browse through all the event processing adapters that are installed in your region by using the browse options (START, NEXT, and END) on INQUIRE EPADAPTER commands.
See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.
The resource signature
You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Identifying changes to resources (resource signatures). See Summary of the resource signature field values for detailed information about the content of the resource signature fields.
Options
- ADAPTERTYPE(cvda)
- Returns
a CVDA value indicating the type of this EP adapter. The CVDA values
are as follows:
- CUSTOM
- A user-written EP adapter that emits events in any format that you require to any destination.
- HTTP
- The HTTP EP adapter that emits events to an HTTP server for consumption by products such as IBM® Operational Decision Manager and IBM Business Monitor.
- TDQUEUE
- The TDQ EP adapter that emits events to a named CICS® transient data queue.
- TRANSTART
- The Transaction Start EP adapter that emits events to a named CICS transaction.
- TSQUEUE
- The TSQ EP adapter that emits events to a named CICS temporary storage queue.
- WMQ
- The IBM MQ EP adapter that emits events to IBM MQ for consumption by products such as IBM Operational Decision Manager and IBM Business Monitor.
- AUTHORITY(cvda)
- Returns
a CVDA value indicating the authority of the EP adapter. The CVDA
values are as follows:
- CONTEXT
- The EP adapter runs using the user ID of the task that caused the event to be captured. This is always the case when EMITMODE is SYNCHRONOUS or when Use Context User ID is specified in the advanced section of the Adapter tab for the EP adapter.
- Default
- The EP adapter runs using the CICS default user ID.
- REGION
- The EP adapter runs using the CICS region user ID.
- USERID
- The EP adapter is attached using the identifier specified in the EP adapter user ID and returned in the AUTHUSERID attribute.
- AUTHUSERID(data-area)
- Returns the 8-character identifier to be used to attach the EP adapter transaction. This attribute is only set if AUTHORITY is USERID.
- CHANGEAGENT(cvda)
- Returns a CVDA value that identifies the agent that made the last
change to the resource definition. The possible values are as follows:
- CREATESPI
- The resource definition was last changed by an EXEC CICS CREATE command.
- CSDAPI
- The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
- CSDBATCH
- The resource definition was last changed by a DFHCSDUP job.
- DREPAPI
- The resource definition was last changed by a CICSPlex® SM BAS API command.
- CHANGEAGREL(data-area)
- Returns a 4-digit number of the CICS release that was running when the resource definition was last changed: for example, 0760 is the identifier for CICS TS for z/OS®, Version 6.3.
- CHANGETIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.
- CHANGEUSRID(data-area)
- Returns the 8-character user ID that ran the change agent.
- CONFIGDATA1(data-area)
- A
64-character data area containing the primary configuration data item
for the EP adapter. If the primary configuration data item is less
than 64 bytes, the field is padded with blanks. The data item returned
is dependent upon ADAPTERTYPE, as follows:
- CUSTOM
- Returns the first 64 bytes of custom EP adapter configuration data.
- HTTP
- Returns the 8-character name of the URIMAP definition to be used by an HTTP EP adapter to locate the HTTP server.
- TDQUEUE
- Returns the 4-character name of the transient data queue for the event emitted by a TDQ EP adapter.
- TRANSTART
- Returns the 4-character name of the event consumer transaction that is started by a Transaction Start EP adapter.
- TSQUEUE
- Returns the 16-character name of the temporary storage queue for the event emitted by a TSQ EP adapter.
- WMQ
- Returns the 48-character name of the IBM MQ queue for event messages emitted by this IBM MQ EP adapter. This data is in the code page defined by the LOCALCCSID system initialization parameter.
- DATAFORMAT(cvda)
- Returns
a CVDA value indicating the format of events emitted by this EP adapter.
The CVDA values are as follows:
- USER
- The format is user-defined.
- CBER
- Common Base Event REST format for the IBM Business Monitor REST HTTP server.
- CBE
- Common Base Event format for consumption by products such as IBM Business Monitor.
- CCE
- CICS Container Event format.
- CFE
- CICS Flattened Event format.
- DSIE
- Decision Server Insights Event format for consumption by the Decision Server Insights component of IBM Operational Decision Manager.
- WBE
- WebSphere® Business Events (XML) format for consumption by the Decision Server Events component of IBM Operational Decision Manager.
- DEFINESOURCE(data-area)
- Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.
- DEFINETIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource definition was created.
- EMITMODE(cvda)
- Returns
a CVDA value indicating the event emission attribute of this EP adapter.
The CVDA values are as follows:
- ASYNCHRONOUS
- Event emission and the capturing transaction are asynchronous. Failure to emit an event has no effect on the capturing transaction.
- SYNCHRONOUS
- Event emission is synchronous with the capturing transaction. The unit of work for the capturing transaction does not complete successfully when the event is not emitted.
- ENABLESTATUS(cvda)
- Returns
a CVDA value indicating the status of this EP adapter. CVDA values
are as follows:
- ENABLED
- The EP adapter is enabled.
- DISABLED
- The EP adapter is disabled.
- EPADAPTER(data-area)
- Specifies the name (1 - 32 characters) of an EP adapter. You must specify this option to retrieve details of a particular EP adapter by name. On the browse form of this command, you must provide a 32-character data area to receive the name of the EP adapter.
- INSTALLAGENT(cvda)
- Returns a CVDA value that identifies the agent that installed
the resource. Only one value is possible:
- BUNDLE
- The resource was installed by a bundle deployment.
- INSTALLTIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource was installed.
- INSTALLUSRID(data-area)
- Returns the 8-character user ID that installed the resource.
- INVOKETYPE(cvda)
- Returns a CVDA value indicating how the EP adapter is started.
The CVDA values are as follows:
- ATTACH
- The EP adapter is attached as a separate task.
- LINK
- The EP adapter program is linked to.
- PRIORITY(cvda)
- Returns a CVDA value indicating the dispatching priority of event
emission for this EP adapter. This attribute is ignored when EMITMODE
is SYNCHRONOUS. The CVDA values are as follows:
- HIGH
- Events emitted for this EP adapter are high priority.
- NORMAL
- Events emitted for this EP adapter are normal priority.
- PROGRAM(data-value)
- Returns the 8-character name of the EP adapter program. If the ADAPTERTYPE is CUSTOM, this attribute is only applicable if INVOKETYPE is LINK.
- TRANSACTION(data-value)
- Returns the 4-character name of the transaction definition that is used if the EP adapter transaction is attached. The TRANSACTION attribute is only applicable if INVOKETYPE is ATTACH.
- TRANSMODE(cvda)
- Returns
a CVDA value indicating the event transactionality attribute of this
EP adapter. CVDA values are as follows:
- NONTRANS
- Events are not transactional. Events can be emitted regardless of whether the unit of work for the capturing transaction completes successfully.
- TRANS
- Events are transactional. Events can be emitted only when the unit of work for the capturing transaction completes successfully.
Conditions
- END
- RESP2
values:
- 2
- There are no more EP adapters to browse.
- 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.
- 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 EP adapter.
- NOTFND
- RESP2
values:
- 3
- The specified EP adapter cannot be found.