Exit XRSINDI

The XRSINDI global user exit is called when CICS® installs or discards a resource definition.

Exit XRSINDI parameters and return codes

Abends in a program that is enabled at the XRSINDI exit point might cause CICS to shut down, because for some resources the exit is driven during sync point. If the exit returns code UERCPURG during the sync point for these resources, abend code AUEP is produced and CICS shuts down.

The parameters, return codes, and XPI information are as follows:

Exit-specific parameters

UEPTRANID

Address of the 4-byte transaction ID.

UEPUSER

Address of the 8-byte user ID.

UEPTERM

Address of the 4-byte terminal ID.

UEPPROG

Address of the 8-byte application program name.

UEPIDREQ

Address of the 1-byte install or discard identifier. The values are as follows:

UEIDINS: This request is for an install action, or, in the case of a log stream, it is a connection to a log stream.
UEIDDIS: This request is for a discard action, or, in the case of a log stream, it is a disconnection from a log stream.

UEPIDTYP

Address of the 1-byte type of resource. The values are as follows:

UEIDATOM: An ATOMSERVICE resource.
UEIDAITM: An autoinstall terminal model.
UEIDBNDL: A BUNDLE resource.
UEIDCONN: A connection.
UEIDDB2C: A DB2CONN resource definition for the connection between CICS and Db2®.
UEIDDB2E: A DB2ENTRY resource definition.
UEIDDB2T: A DB2TRAN resource definition.
UEIDDOCT: A DOCTEMPLATE.
UEIDDMPC: A DUMPCODE resource definition.
UEIDEARB: An EAR file that is part of a CICS bundle.
UEIDEBAB: An EBA file that is part of a CICS bundle.
UEIDEPAD: An EPADAPTER resource.
UEIDEPAS: An EPADAPTERSET resource.
UEIDEVCS: An event capture resource.
UEIDEVNT: An EVENTBINDING resource.
UEIDFECO: A FEPI connection.
UEIDFENO: A FEPI node.
UEIDFEPO: A FEPI pool.
UEIDFEPS: A FEPI property set.
UEIDFETA: A FEPI target.
UEIDFILE: A file.
UEIDIPCO: An IPCONN resource.
UEIDJNMD: A journal model.
UEIDJNNM: A journal name.
UEIDJSRV: A JVM server resource.
UEIDLBRY: A LIBRARY resource.
UEIDMAP: A mapset.
UEIDMODE: A modegroup.
UEIDMPPP: A Policy resource.
UEIDMQCN: An MQCONN resource definition for the connection between CICS and IBM® MQ.
UEIDMQIN: An MQINI resource.
UEIDMQMN: An MQMONITOR resource.
UEIDNAPP: A NODEJSAPP resource.
UEIDNQRN: An ENQMODEL.
UEIDOSGB: An OSGi bundle.
UEIDPART: A partner.
UEIDPIPE: A pipeline (PIPELINE).
UEIDPKST: A Db2 PACKAGESET resource.
UEIDPROF: A profile.
UEIDPROG: A program.
UEIDPRTY: A BTS process type.
UEIDPSET: A partition set.
UEIDSESS: A session.
UEIDSTRM: An MVS log stream.
UEIDTCLS: A transaction class.
UEIDTCPS: A TCP/IP service.
UEIDTDQU: A transient data queue.
UEIDTERM: A terminal.
UEIDTRAN: A transaction.
UEIDTSMD: A temporary storage queue model.
UEIDURIM: A URIMAP resource.
UEIDWARB: A WAR file that is part of a CICS bundle.
UEIDWEBS: A web service (WEBSERVICE).
UEIDXMLT: An XMLTRANSFORM resource.

UEPIDLEN

For public resources, this parameter is the address of the length of an individual resource name, as a fullword binary value.

For OSGi bundles, this parameter is the address of the length of the information that uniquely identifies an OSGi bundle in CICS in the UEPIDNAM parameter. The maximum length is 526 bytes.

UEPIDNUM

Address of the number of resources that are reported by this call, as a fullword binary value.

UEPIDNAM

Address of a variable-length list containing the names of the individual resources reported by this call.

For OSGi bundles, this parameter contains the information that uniquely identifies an OSGi bundle in CICS. The information is listed in the following order:

8 bytes that contain the JVM server name.
A fullword containing the length of the OSGi bundle symbolic name.
A fullword containing the length of the OSGi bundle version.
A concatenation of the OSGi bundle symbolic name and version as a character string.

UEPIDREC

Address of a 1-byte identifier indicating whether resources are recovered at a warm or emergency restart. The values are as follows:

UEIDKEEP: The resources are recoverable at a warm or emergency restart.
UEIDLOSE: The resources are not recoverable.

Note: The exit is not driven during a CICS restart.

UEPDEFTM

The address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the definition time of the individual resource as an 8-character STCK value.

Note: The parameters UEPDEFTM, UEPCHUSR, UEPCHAGT, UEPCHREL, UEPCHTIM, UEPDEFSRC, UEPINUSR, UEPINTIM, and UEPINAGT are valid for the following resources: ATOMSERVICE, BUNDLE, CONNECTION, DB2CONN, DB2ENTRY, DB2TRAN, DOCTEMPLATE, DUMPCODE, ENQMODEL, EPADAPTER, EPADAPTERSET, EVENTBINDING, FILE, IPCONN, JOURNALMODEL, JVMSERVER, LIBRARY, MQCONN, MQINI, NODEJSAPP, OSGIBUNDLE, PIPELINE, PROFILE, PROCESSTYPE, PROGRAM, TCPIPSERVICE, TDQUEUE, TRANCLASS, TRANSACTION, TSMODEL, URIMAP, WEBSERVICE, and XMLTRANSFORM. The parameter value is zero for all other resources.

UEPCHUSR

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the 8-character user ID that ran the agent that last changed the individual resource.

UEPCHAGT

Address of a variable-length list, which corresponds to the list in UEPIDNAM, of a 2-byte identifier representing the agent that last changed the individual resource. The possible values are as follows:

UEPUNKAGT: The resource was changed by an unknown agent.

UEPCSDAPI: The resource was changed using the CSD API or CEDA.

UEPCSDBAT: The resource was changed using the CSD batch program, DFHCSDUP.

UEPDRPAPI: The resource was changed using the CICSPlex® SM BAS API.
UEPAUTOIN: The resource was changed using autoinstall.
UEPSYSTEM: The resource was changed by the running CICS region.
UEPDYNAMC: The resource was changed dynamically.
UEPTABLE: The resource was changed using a table.

UEPCHREL

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the 4-character CICS release level that was running when the individual resource was last changed.

UEPCHTIM

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the CSD record time stamp change for the individual resource as an 8-character STCK value.

UEPDEFSRC

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the 8-character CSD group name or source corresponding to the individual resource.

UEPINUSR

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the 8-character user ID that installed the individual resource.

UEPINTIM

Address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the time that the domain was called for the installation of the individual resource as an 8-character STCK value.

UEPINAGT

Address of a variable-length list, which corresponds to the list in UEPIDNAM, of a 2-byte identifier representing the agent that installed the individual resource. The possible values are as follows:

UEPCSDAPI: The resource was installed using the CSD API or CEDA.

UEPCRESPI: The resource was installed using the EXEC CICS CREATE SPI commands.

UEPGRPLST: The resource was installed at startup using GRPLIST install.

UEPAUTOIN: The resource was autoinstalled.

UEPSYSTEM: The resource was installed by the running CICS system.
UEPDYNAMC: The resource was installed dynamically.
UEPBUNDLE: The resource was installed by a bundle deployment.
UEPTABLE: The resource was installed using a table.

UEPAPPTK

Address of a variable-length list, containing an 8-character token representing the application instance to which this resource belongs. For public resources, this address is zero.

UEPAPCTXT

For private resources for applications that are deployed on platforms, this parameter contains the address of a variable-length list, which corresponds to the list in UEPIDNAM, containing the application context information for the resource. The information is listed in the following order:

The platform name, padded with spaces to 64 characters.
The application name, padded with spaces to 64 characters.
The major version number for the application, which is a fullword binary value.
The minor version number for the application, which is a fullword binary value.
The micro version number for the application, which is a fullword binary value.

CICS supplies a DSECT named DFHUEACD which maps this information. For more information about DFHUEACD, see UEACD - User exit application context.

UEPPLATTK

Address of a variable-length list, containing an 8-character token representing the platform instance to which this resource belongs. For public resources, this address is zero.

Return codes

UERCNORM: Continue processing. This code is the default.
UERCPURG: Task purged during XPI call.

XPI calls

You can use all XPI calls.