INQUIRE PIPELINE

Retrieve information about an installed PIPELINE.

INQUIRE PIPELINE

Conditions: NOTAUTH, NOTFND

This command is threadsafe.

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

Description

Use the INQUIRE PIPELINE command to retrieve information about an installed pipeline.

Browsing

You can browse through all the pipelines installed in your system by using the browse options, START, NEXT, and END, on INQUIRE PIPELINE 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 Auditing resources. The resource signature fields are BUNDLE, CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

PIPELINE(data-value)

Specifies the name of the pipeline about which you are inquiring. The name can be up to 8 characters long.

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.

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.

CIDDOMAIN(data-area)

Returns the domain name that is used to generate MIME content-ID values to identify binary attachments in containers. The name can be up to 255 characters long.

CONFIGFILE(data-area)

Returns the name of the pipeline configuration file associated with the pipeline resource. The name can be up to 255 characters long.

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.

ENABLESTATUS(cvda)

Returns the status of the PIPELINE:

ENABLED: The pipeline is ready for use.
DISABLED: The pipeline is not processing requests, and cannot to accept new work. It might have failed to initialize or might have been explicitly disabled.
ENABLING: The pipeline is being initialized; it is not yet ready to accept work.
DISABLING: The pipeline is quiescing before entering DISABLED state. It is not accepting new work, but is allowing current work to complete.
DISCARDING: A DISCARD command has been issued for the pipeline. The pipeline is quiescing before being discarded. It is not accepting new work, but is allowing current work to complete.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

BUNDLE: The resource was installed by a bundle deployment.
CREATESPI: The resource was installed by an EXEC CICS CREATE command.
CSDAPI: The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
GRPLIST: The resource was installed by GRPLIST INSTALL.

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.

MODE(cvda)

Returns the operating mode of the pipeline. CVDA values are as follows:

PROVIDER: CICS is using the pipeline as a service provider.
REQUESTER: CICS is using the pipeline as a service requester.
UNKNOWN: The operating mode of the pipeline cannot be determined.

MSGFORMAT(data-area)

Returns an 8-byte character string that indicates the message format processed by the PIPELINE.

SOAP11: The pipeline processes the SOAP 1.1 message format.
SOAP12: The pipeline processes the SOAP 1.2 message format, and can also process the SOAP 1.1 message format.
JSON: The pipeline processes the JSON message format.
OTHER: The pipeline processes other message formats, such as customer-specified formats.

MTOMNOXOPST(cvda)

Returns a value that indicates whether MTOM will be used for outbound SOAP messages when no binary attachments are present.

MTOMNOXOP: Use MTOM, even when no binary attachments are present.
NOMTOMNOXOP: Do not use MTOM unless binary attachments are present.

MTOMST(cvda)

Returns a value that indicates whether support for MTOM has been enabled in the pipeline.

MTOM: MTOM support has been enabled in the pipeline.
NOMTOM: MTOM support has not been enabled in the pipeline.

RESPWAIT(data-area)

Returns the number of seconds that an application program waits for an optional response message from a remote Web service. If the returned value is -1, no value has been set for the pipeline and the default timeout value of the transport protocol is being used.

The default timeout value for HTTP is 10 seconds.
The default timeout value for WebSphere® MQ is 60 seconds.

SENDMTOMST(cvda)

Returns a value that indicates when MTOM will be used for outbound SOAP messages.

NOSENDMTOM: Do not use MTOM for outbound SOAP messages.
SAMESENDMTOM: Use MTOM for outbound SOAP message responses when the inbound message is received in MTOM format.
SENDMTOM: Always use MTOM for outbound SOAP messages.

SHELF(data-area)

Returns the name of the shelf directory. The name can be up to 255 characters long. This field is blank for a PIPELINE resource that is installed in a CICS bundle.

SOAPLEVEL(data-area)

Returns an 8-byte character string stating the highest SOAP level supported by the pipeline handler. The value of the SOAP level is 1.1 or 1.2. If the pipeline is not being used for SOAP messages, a value of NOTSOAP is returned.

SOAPRNUM(data-area)

Returns a fullword binary value of the release number for the highest SOAP level supported by the pipeline handler. The value of the release number is 1 or 2.

SOAPVNUM(data-area)

Returns a fullword binary value of the version number for the highest SOAP level supported by the pipeline handler. The value of the version number is 1.

WSDIR(data-area)

Returns the name of the Web service binding directory (also known as the pickup directory). The name can be up to 255 characters long.

XOPDIRECTST(cvda)

Returns a value that indicates whether the pipeline can currently handle XOP documents in direct mode.

XOPDIRECT: The pipeline supports the direct processing of XOP documents and binary attachments.
NOXOPDIRECT: The pipeline does not support the direct processing of XOP documents and binary attachments. Compatibility mode is in operation.

XOPSUPPORTST(cvda)

Returns a value that indicates whether the application handler for the pipeline supports the processing of XOP documents and binary attachments.

XOPSUPPORT: The application handler supports XOP documents.
NOXOPSUPPORT: The application handler does not support XOP documents.

Conditions

NOTAUTH

RESP2 values:

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

NOTFND

RESP2 values:

3: The PIPELINE cannot be found.