Table 81 summarizes the
Pipeline Manager domain's specific gates. It shows the level-1 trace point
IDs of the modules providing the functions for the gate, the functions provided
by the gate, and whether or not the functions are available through the exit
programming interface (XPI).
Table 81. Pipeline Manager domain's specific gates
Gate |
Trace |
Function |
XPI |
PIAT |
PI 0D00
PI 0D01
|
CREATE_CONTEXT
CREATE_CONTEXT_RESP
CREATE_NON_TERMINAL_MSG
CREATE_REGISTER_REQUEST
CREATE_REGISTER_RESP
CREATE_TERMINAL_MSG
PROCESS_CONTEXT
PROCESS_CONTEXT_RESP
PROCESS_MSG
|
No |
PICC |
PI 0F30
PI 0F31
|
FIND_SIGNATURE
HANDLE_PARSE_EVENT
PERFORM_XML_PARSE
|
No |
PIII |
PI 0F00
PI 0F01
|
PARSE_ICM
|
No |
PIPL |
PI 0400
PI 0401
|
ADD_PIPELINE
COMPLETE_PIPELINE
DISCARD_PIPELINE
END_BROWSE_PIPELINE
ESTABLISH_PIPELINE
GET_NEXT_PIPELINE
INQUIRE_PIPELINE
PERFORM_PIPELINE
RELINQUISH_PIPELINE
RESOLVE_PIPELINE
SET_PIPELINE
START_BROWSE_PIPELINE
|
No |
PIPM |
PI 0A00
PI 0A01
|
INVOKE_PROGRAM
INVOKE_STUB
START_PIPELINE
|
No |
PIRE |
PI 0D90
PI 0D92
|
PERFORM_RESYNC
|
No |
PISC |
PI 0E00
PI 0E01
|
DYN_CREATE_WEBSERVICE
UPDATE_WEBSERVICE
|
No |
PISF |
PI 0C00
PI 0C01
|
SOAPFAULT_ADD
SOAPFAULT_CREATE
SOAPFAULT_DELETE
|
No |
PISN |
PI 0C10
PI 0C11
|
SOAP_11
SOAP_12
|
No |
PITG |
PI 0700
PI 0701
|
SEND_REQUEST
SEND_RESPONSE
CONVERSE
RECEIVE_REQUEST
SEND_ERROR_RESPONSE
|
No |
PITL |
PI 1000
PI 1001
|
PROCESS_SOAP_REQUEST_FUNCTION
|
No |
PIWR |
PI 0300
PI 0301
|
CREATE_WEBSERVICE
DECREMENT_USE_COUNT
DISCARD_WEBSERVICE
END_BROWSE_WEBSERVICE
GET_NEXT_WEBSERVICE
INCREMENT_USE_COUNT
INITIALISE_WEBSERVICE
INQUIRE_WEBSERVICE
RESOLVE_ALL_WEBSERVICES
SET_WEBSERVICE
START_BROWSE_WEBSERVICE
|
No |
Creates a WSAT coordination context SOAP header.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a null context response, which is returned when a WSAT participant
send back its output.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated dfhheader container is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a non-terminal SOAP message used in WS-AtomicTransaction
two-phase commit protocol processing. Non-terminal messages anticipate a response.
They are used to convey the following function requests: Prepare, Commit,
Rollback, and Replay.
Input Parameters
- NOTIFICATION_TYPE
- Values for the parameter are:
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a WSAT registration request SOAP message.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
-
The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a WSAT registration response SOAP message.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a terminal SOAP message used in WS-AtomicTransaction two-phase
commit protocol processing. Terminal messages do not anticipate a response.
They are used to convey the following function requests: Prepared, Committed,
Aborted, and Readonly.
Input Parameters
- NOTIFICATION_TYPE
- Values for the parameter are:
- ABORTED
- COMMITTED
- PREPARED
- READONLY
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
-
The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Process a WS-AtomicTransaction coordination context header.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
-
The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Input Parameters
- POOL_TOKEN
-
Output Parameters
- REASON
-
The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Process a WS-AtomicTransaction message. This can be a Register
Request, a Register Response, a Non Terminal message, or a Terminal Message.
Input Parameters
- POOL_TOKEN
- A token to the current container pool, which holds data used to build
the header, and where the populated DFHHEADER container is placed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NO_CHANNEL
- PGCR_GET_ERROR
- PGCR_PUT_ERROR
- SMGF_ERROR
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Determine an operation from its signature
Input Parameters
- OUTPUT_DATA
- A pointer to the operation in the internal COMMAREA or container model
(ICM)
- XML_BODY_STRING
- The incoming SOAP message
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- HEAP_INIT_FAILURE
- INSUFFICIENT_STORAGE
- INTERNAL_FAILURE
- INVALID_PARSE_STATE
- SAXHANDLER_LINK_FAILURE
The following values are returned when RESPONSE is EXCEPTION:
- FIXED_ELEMENT_COUNT
- HEAP_ALLOCATE_FAILURE
- HEAP_RELEASE_FAILURE
- ICM_ENTRY_NOT_FOUND
- INQUIRE_CHANNEL_FAILED
- OUTPUT_BUFFER_OVERFLOW
- PUT_CONTAINER_FAILED
- SOAP_FAULT
The following values are returned when RESPONSE is EXCEPTION:
- COMMAREA_LENGTH
- INVALID_FUNCTION
- INVALID_ICM_TYPE
- INVALID_INPUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Handle an XML parse event when located by the PL/I SAX parser
Input Parameters
- EVENT_TOKEN
- A pointer to the event token provided by the XML parser.
- EVENT_TOKEN_LENGTH
- The length of the event token.
- EVENT_TYPE
- A BIN(31) value indicating what event has been signaled by the parser.
- HANDLER_WORK_TOKEN
- A pointer to the DFHPICC work area.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- HEAP_INIT_FAILURE
- INSUFFICIENT_STORAGE
- INTERNAL_FAILURE
- INVALID_PARSE_STATE
- SAXHANDLER_LINK_FAILURE
The following values are returned when RESPONSE is EXCEPTION:
- FIXED_ELEMENT_COUNT
- HEAP_ALLOCATE_FAILURE
- HEAP_RELEASE_FAILURE
- ICM_ENTRY_NOT_FOUND
- INQUIRE_CHANNEL_FAILED
- OUTPUT_BUFFER_OVERFLOW
- PUT_CONTAINER_FAILED
- SOAP_FAULT
The following values are returned when RESPONSE is INVALID:
- COMMAREA_LENGTH
- INVALID_FUNCTION
- INVALID_INPUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Parse a SOAP body and convert the data elements into a COMMAREA
format.
Input Parameters
- ICM_ADDRESS
- The address of the internal COMMAREA or container model (ICM) which is
to be used for the SOAP to COMMAREA conversion.
- OUTPUT_DATA
- A pointer to, and length of, the COMMAREA into which the SOAP body has
been mapped.
- XML_BODY_STRING
- A pointer to the incoming SOAP body.
- CHANNEL_NAME
- The name of the channel which contains the SOAP body.
- XML_HEADER_NS
- Optional Parameter
A pointer to the XML namespace information for the SOAP body.
- XML_OPERATION
- Optional Parameter
The operation name for which the SOAP body is intended.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- HEAP_INIT_FAILURE
- INSUFFICIENT_STORAGE
- INTERNAL_FAILURE
- INVALID_PARSE_STATE
- SAXHANDLER_LINK_FAILURE
The following values are returned when RESPONSE is EXCEPTION:
- FIXED_ELEMENT_COUNT
- HEAP_ALLOCATE_FAILURE
- HEAP_RELEASE_FAILURE
- ICM_ENTRY_NOT_FOUND
- INQUIRE_CHANNEL_FAILED
- OUTPUT_BUFFER_OVERFLOW
- PUT_CONTAINER_FAILED
- SOAP_FAULT
The following values are returned when RESPONSE is INVALID:
- COMMAREA_LENGTH
- INVALID_FUNCTION
- INVALID_INPUT
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Convert an outbound COMMAREA or container into a SOAP body.
Input Parameters
- CHANNEL_NAME
- Optional parameter
The name of the channel which holds the container with the SOAP body.
- INPUT_COMMAREA
- The address and length of the COMMAREA or container to convert.
- OUTPUT_ICM_ADDRESS
- The address of the internal COMMAREA or container model (ICM) that defines
how to map the COMMAREA or container to a SOAP body.
- OUTPUT_XML
- The address of the SOAP body.
Output Parameters
- REASON
- Values for the parameter are:
- ABEND
- BUFFER_OVERFLOW
- CONTAINER_GET_FAILURE
- FREEMAIN_FAILURE
- GETMAIN_FAILURE
- HEAP_INIT_FAILURE
- ICM_NOT_FOUND
- INPUT_ERROR
- INSUFFICIENT_STORAGE
- INVALID_FORMAT
- INVALID_FUNCTION
- INVALID_ICM_DATATYPE
- MALLOC_FAILURE
- NOT_AUTHORIZED
- RELEASE_FAILURE
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
This function supports the INVOKE WEBSERVICE API where CICS is
acting as Web Service Requester. Depending upon the attributes specified in
the WEBSERVICE resource, it calls the Pipeline Manager (DFHPIPM) to start
the pipeline, or it links directly to an application program directly.
Input Parameters
- CHANNEL
- The name of a channel which holds the container in which data is passed
to the target WEBSERVICE.
- OPERATION
- The name of the operation which is to be invoked.
- WEBSERVICE
- The name of the WEBSERVICE resource.
- URI
- Optional Parameter
The URI of the target Web service. If this parameter is omitted, the WEBSERVICE
resource must specify an endpoint or a program.
Output Parameters
- REASON
- Values for the parameter are:
- CHANNEL_NOT_FOUND
- CHANNEL_ERROR
- CONTAINER_DATATYPE_ERR
- CONTAINER_NOT_FOUND
- ENDPOINT_NOT_PROVIDED
- INVALID_CHANNEL_NAME
- INVALID_FUNCTION
- INVALID_OPERATION
- INVALID_URI
- INVALID_WSBIND_FORMAT
- OPERATION_NOT_FOUND
- PARSE_CONVERSION_ERROR
- PARSE_INPUT_ERROR
- PIPELINE_MODE_MISMATCH
- PIPELINE_NOT_ACTIVE
- PIPELINE_NOT_FOUND
- PROGRAM_LINK_FAILED
- SOAP_FAULT_BUILT
- UNHANDLED_PIPELINE_ERROR
- VENDOR_LINK_FAILED
- WEBSERVICE_NOT_FOUND
- WEBSERVICE_NOT_INSERVICE
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
- SOAP_FAULT_RESP1
- The response that was returned from the SOAP message handler's fault processing
in the DFHWS-RESPCODES container.
- SOAP_FAULT_RESP2
- The reason that was returned from the SOAP message handler's fault processing
in the DFHWS-RESPCODES container.
Add a PIPELINE definition to the system.
Input Parameters
- CONFIGFILE
- The fully qualified name of the XML pipeline configuration file on HFS.
- PIPELINE
- The name of the PIPELINE.
- SHELF
- The fully qualified name of a directory (or shelf) primarily for WSBIND
and WSDL files.
- STATUS
- The initial state of the PIPELINE.
Values for the parameter are:
- WSDIR
- Optional Parameter
The fully qualified name of the WSBIND directory on HFS.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CATALOG_ERROR
- DIRECTORY_ERROR
- INVALID_HFSNAME
- INVALID_NAME
- INVALID_SHELF
- INVALID_STATUS
- INVALID_WSDIR
- NOT_AUTHORIZED
- NOT_DISABLED
- WSDIR_INACCESIBLE
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Complete the installation of a PIPELINE. PIPELINEs are installed
in two phases: this is the second, called after CICS initialization is complete.
This function reads data from the files in HFS and builds the internal control
blocks.
Input Parameters
- PIPELINE
- The name of the PIPELINE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CATALOG_ERROR
- DIRECTORY_ERROR
- INVALID_HFSNAME
- INVALID_NAME
- INVALID_SHELF
- INVALID_STATUS
- INVALID_WSDIR
- NOT_AUTHORIZED
- NOT_DISABLED
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Input Parameters
- PIPELINE
- The name of the PIPELINE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CATALOG_ERROR
- DISCARD_IN_PROGRESS
- INVALID_BROWSE_TOKEN
- NOT_AUTHORIZED
- NOT_DISABLED
- NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
End the browse operation on the PIPELINE resources that are installed
in the system.
Input Parameters
- BROWSETOKEN
- A token that represents the browse operation on subsequent GET_NEXT_PIPLINE
and END_BROWSE requests.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- INVALID_BROWSE_TOKEN
- LOOP
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Check that a PIPELINE is in a state in which it can be used, and
increment its use count.
Input Parameters
- PIPELINE
- The name of the PIPELINE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CATALOG_ERROR
- INVALID_STATUS
- NOT_AUTHORIZED
- NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
During a browse operation, extract information about the next PIPELINE.
Input Parameters
- BROWSETOKEN
- The browse token that was returned by the START_BROWSE_PIPELINE function.
- CONFIGFILE_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the XML pipeline configuration
file on HFS is returned.
- RESET
- Optional Parameter
A parameter indicating whether the statistics for the PIPELINE are to
be reset.
Values for the parameter are:
- SHELF_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the directory (or shelf)
for WSBIND and WSDL files is returned.
- WSDIR_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the WSBIND directory on
HFS is returned.
Output Parameters
- PIPELINE
- The name of the PIPELINE.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- BROWSE_END
- INVALID_BROWSE_TOKEN
- LOCK_ERROR
- LOOP
- PARMS_STORAGE_ERROR
- SETUP_ERROR
- STORAGE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
- STATUS
- Optional Parameter
The current status of the PIPELINE.
Values for the parameter are:
- DISABLING
- DISABLED
- DISCARDING
- ENABLED
- ENABLING
- TOTAL_USE_COUNT
- Optional Parameter
The current use count of the PIPELINE.
Inquire on the attributes, state and associated resources of a
PIPELINE.
Input Parameters
- PIPELINE
- The name of the PIPELINE.
- CONFIGFILE_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the XML pipeline
configuration file on HFS is returned.
- DERIVED_SHELF_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the HFS file which contains
the WSDL for the PIPELINE is returned.
- SHELF_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the directory (or shelf)
for WSBIND and WSDL files is returned.
- WSDIR_BUFF
- Optional Parameter
A buffer in which the fully qualified name of the WSBIND directory on
HFS is returned.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
- MODE
- Optional Parameter
The MODE of the PIPELINE.
Values for the parameter are:
- PROVIDER
- REQUESTER
- UNKNOWN
- PIPELINE_TOKEN
- Optional Parameter
A token which can be used by other parts of the domain to refer to the
PIPELINE.
- STATUS
- Optional Parameter
The current status of the PIPELINE.
Values for the parameter are:
- DISABLING
- DISABLED
- DISCARDING
- ENABLED
- ENABLING
- TOTAL_USE_COUNT
- Optional Parameter
The current use count of the PIPELINE.
Perform the specified action on a PIPELINE.
Input Parameters
- ACTION
- The only supported action is SCAN. The PIPELINE is scanned
for WSBIND files which are then installed.
Values for the parameter are:
- PIPELINE
- The name of the PIPELINE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- DUPLICATE
- INVALID_ACTION
- INVALID_STATUS
- LOOP
- NOT_AUTHORIZED
- NOT_FOUND
- PIPELINE_SCAN_ERROR
- SCAN_ALREADY_IN_PROGRESS
- WSDIR_INACCESSIBLE
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Relinquish the use of a PIPELINE. The use count is decremented,
and if it is then zero, and the PIPELINE's state is DISABLING, the status
changes to DISABLED.
Input Parameters
- PIPELINE
- The name of the PIPELINE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CATALOG_ERROR
- NOT_AUTHORIZED
- NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
For each PIPELINE, start a transaction to complete PIPELINE installation.
The function is used at the end of domain initialization.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- LOOP
- SETUP_ERROR
- STORAGE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Set a PIPELINE to DISABLED or ENABLED state.
Input Parameters
- PIPELINE
- The name of the PIPELINE.
- STATUS
- The state to be set.
Values for the parameter are:
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_STATE
- NOT_AUTHORIZED
- NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Start browsing the installed PIPELINE resources.
Input Parameters
- PIPELINE
- Optional Parameter
The name of the PIPELINE at which the browse is to begin.
Output Parameters
- BROWSETOKEN
- A token that identifies the browse operation to subsequent GET_NEXT_PIPELINE
and END_BROWSE reqeusts.
- REASON
- Values for the parameter are:
- ABEND
- INVALID_PIPELINE
- LOCK_ERROR
- LOOP
- SETUP_ERROR
- STORAGE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Invoke a PIPELINE's application programs. The function can change
the transaction's context, and the request can be routed to another region.
Input Parameters
- CHANNEL
- The channel to be passed to the target program.
- PROGRAM
- The program to be invoked.
- APPLID
- Optional Parameter
The APPLID to be used for the execution of the application program.
- RS_PUBLIC_ID
- Optional Parameter
The request stream public identifier to be associated with the transaction.
- TRANSID
- Optional Parameter
The transaction identifier to be used to execute the application program.
- USERID
- Optional Parameter
The user ID to be used for the execution of the application program.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- CHANNEL_ERROR
- CONTEXT_SWITCH_FAILED
- NO_CHANNEL
- PIPELINE_MODE_MISMATCH
- PIPELINE_NOT_ACTIVE
- PIPELINE_NOT_FOUND
- RZ_CREATE_FAILURE
- RZ_TRANSPORT_ERROR
- TARGET_PROGRAM_UNAVAILABLE
- UNHANDLED_NODE_FAILURE
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is PURGED:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Invoke an application program remotely.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- CHANNEL_ERROR
- CONTEXT_SWITCH_FAILED
- NO_CHANNEL
- PIPELINE_MODE_MISMATCH
- PIPELINE_NOT_ACTIVE
- PIPELINE_NOT_FOUND
- RZ_CREATE_FAILURE
- RZ_TRANSPORT_ERROR
- TARGET_PROGRAM_UNAVAILABLE
- UNHANDLED_NODE_FAILURE
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is PURGED:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Start a requester or provider pipeline.
Input Parameters
- MODE
- Parameter indicating whether the pipeline is to be started for a service
requester or for a service provider.
Values for the parameter are:
- PIPELINE
- The name of the PIPELINE resource.
- CHANNEL
- Optional Parameter
The name of a channel holding containers to be passed to the pipeline.
- TRANSPORT_NAME
- Optional Parameter
Depending upon the value of the TRANSPORT_TYPE parameter, the name of
a TCPIPSERVICE or an MQ queue to be passed to the pipeline.
- TRANSPORT_TYPE
- Optional Parameter
Parameter indicating the type of transport.
Values for the parameter are:
- WEBSERVICE
- Optional Parameter
The name of the WEBSERVICE to be invoked for this pipeline.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- CHANNEL_ERROR
- CONTEXT_SWITCH_FAILED
- NO_CHANNEL
- PIPELINE_MODE_MISMATCH
- PIPELINE_NOT_ACTIVE
- PIPELINE_NOT_FOUND
- RZ_CREATE_FAILURE
- RZ_TRANSPORT_ERROR
- TARGET_PROGRAM_UNAVAILABLE
- UNHANDLED_NODE_FAILURE
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is PURGED:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Resynchronize any WS-AtomicTransaction units of work that are in-doubt,
following a restart of CICS.
Input Parameters
None.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
This function dynamically creates a WEBSERVICE resource via a PIPELINE
scan.
Input Parameters
- PIPELINE
- The name of the PIPELINE resource that owns the WEBSERVICE.
- WSBIND
- The fully qualified location of the Web service binding file in the pickup
directory in the hierarchical file system (HFS).
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CREATE_FAILED
- DISCARD_FAILED
- INQUIRE_FAILED
- INQUIRE_HFS_FAILED
- NAME_CLASH
- NO_UPDATE_NEEDED
- UPDATE_PENDING
- WSDL_NAME_TOO_LONG
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
This function completes the updating of a WEBSERVICE resource.
It is invoked when the use count for a WEBSERVICE which is in UPDATING state
reaches zero.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE whose update is to be completed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CREATE_FAILED
- DISCARD_FAILED
- INQUIRE_FAILED
- INQUIRE_HFS_FAILED
- NAME_CLASH
- NO_UPDATE_NEEDED
- UPDATE_PENDING
- WSDL_NAME_TOO_LONG
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Add extra data to a SOAP fault created by the SOAPFAULT_CREATE
function.
Input Parameters
- FAULT_STRING
- The description of the fault in a readable form.
- SUBCODE_STRING
- The value to put in the <subcode> element of a SOAP
fault.
- CCSID
- Optional Parameter
The CCSID of the input.
- NATLANG
- Optional Parameter
The xml:lang value for the FAULT_STRING
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CCSID_CONVERSION_ERROR
- CCSID_INVALID
- CCSID_PARTIAL_CONVERSION
- CCSID_UNSUPPORTED
- INVALID_CODE
- INVALID_REQUEST
- NO_FAULT
- SEVERE_ERROR
- RESPONSE
-
Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Create a SOAP fault in an internal format.
Input Parameters
- FAULT_STRING
- The description of the fault in a readable form.
- FAULTCODE
- The standard SOAP fault code to use
- FAULTCODE_STRING
- The value to use for the <faultcode> element instead
of a standard one.
- CCSID
- Optional Parameter
The CCSID of the input.
- DETAIL
- Optional Parameter
XML containing detailed fault data.
- FAULT_ACTOR
- Optional Parameter
The value to put in the <faultactor> element.
- NATLANG
- Optional Parameter
The xml:lang value for the FAULT_STRING parameter.
- ROLE
- Optional Parameter
The value to put in the <role> element.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CCSID_CONVERSION_ERROR
- CCSID_INVALID
- CCSID_PARTIAL_CONVERSION
- CCSID_UNSUPPORTED
- INVALID_CODE
- INVALID_REQUEST
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Delete the internal form of a SOAP fault.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- NO_FAULT
- NOT_FOUND
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Start a message handler to process SOAP 1.1 messages.
Output Parameters
- SOAPFAULT
- indicates whether a SOAP fault has been built.
Values for the parameter are:
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- BAD_FAULT
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Start a message handler to process SOAP 1.2 messages.
Output Parameters
- SOAPFAULT
- indicates whether a SOAP fault has been built.
Values for the parameter are:
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- BAD_FAULT
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Input Parameters
None
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- invalid_codepage
- socket_error
- unknown_host
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_PARAMETER
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Input Parameters
None
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- invalid_codepage
- socket_error
- unknown_host
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_PARAMETER
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Input Parameters
None
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- invalid_codepage
- socket_error
- unknown_host
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_PARAMETER
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Input Parameters
None
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- codepage_not_found
- connection_closed
- socket_error
The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_PARAMETER
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Input Parameters
None
Output Parameters
- REASON
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
The following values are returned when RESPONSE is DISASTER:
The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_PARAMETER
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Process a SOAP body received on a SOAP pipeline
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- APP_FAULT
- CONV_FROM_SOAP_FAILED
- CONV_TO_SOAP_FAILED
- INBOUND_VALIDATION_FAILED
- INVALID_FORMAT
- INVALID_FUNCTION
- LOOP
- NOT_AUTHORIZED
- OPERATION_NOT_FOUND
- OUTBOUND_VALIDATION_FAILED
- SEVERE_ERROR
- SOAP_BODY_CONTAINER_FAULT
- TARGET_ABENDED
- TARGET_LINK_FAILED
- VENDOR_LINK_FAILED
- WSBIND_FORMAT_INVALID
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Create a new WEBSERVICE resource.
Input Parameters
- PIPELINE
- The pipeline which will own the WEBSERVICE.
- WEBSERVICE
- The name of the WEBSERVICE.
- WSBIND_BUF
- The location of the Web service binding file in the hierarchical file
system (HFS).
- SCAN_MODE
- Optional Parameter
Indicates whether the WEBSERVICE is being scanned in or not.
Values for the parameter are:
- VALIDATION
- Optional Parameter
Indicates whether validation is enabled for the WEBSERVICE.
Values for the parameter are:
- WARM_RESTART
- Optional Parameter
Indicates whether the WEBSERVICE is to be recovered from the catalog during
a warm restart.
Values for the parameter are:
- WSDLFILE_BUF
- Optional Parameter
The location of the optional Web service description (WSDL) file in the
hierarchical file system (HFS).
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- DIRECTORY_ERROR
- INSUFFICIENT_STORAGE
- LOCK_FAILURE
- PIPELINE_ERROR
- PIPELINE_NON_EXISTANT
- SEVERE_ERROR
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Decrement the current use count for a WEBSERVICE. When it reaches
0 and if the WEBSERVICE is updating or discarding then the completion of the
update or discard operation will be triggered.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
This function discards a WEBSERVICE resource.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- NOT_AUTHORIZED
- SEVERE_ERROR
- WEBSERVICE_IN_USE
- WEBSERVICE_NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
This function ends a browse operation for WEBSERVICE resources.
Input Parameters
- BROWSE_TOKEN
- The browse token for the browse operation.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
Get the next WEBSERVICE resource during a browse operation.
Input Parameters
- BROWSE_TOKEN
- The browse token for the browse operation.
- BINDING_BUF
- Optional Parameter
A buffer in which the WSDL binding value is returned.
- ENDPOINT_BUF
- Optional Parameter
A buffer in which the end point URI is returned.
- RESET
- Optional Parameter
A flag that indicates if the use count is to be reset to zero.
Values for the parameter are:
- WSBIND_BUF
- Optional Parameter
A buffer in which the location of the Webservice binding file in the hierarchical
file system (HFS) is returned.
- WSDLFILE_BUF
- Optional Parameter
A buffer in which the location of the Web service description (WSDL) file
in the hierarchical file system (HFS) is returned.
Output Parameters
- DATESTAMP
- The date stamp of the Web service binding file
- LASTMODTIME
- The time at which the Web service binding file was last changed.
- PGMINTERFACE
- The type of interface used by the target program
Values for the parameter are:
- PIPELINE
- The pipeline which owns the WEBSERVICE.
- PROGRAM
- The target program.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- BROWSE_END
- INVALID_BROWSE_TOKEN
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
- STATE
- The current state of the WEBSERVICE.
Values for the parameter are:
- DISCARDING
- INITING
- INSERVICE
- UNUSABLE
- UPDATING
- TIMESTAMP
- The time stamp of the Web service binding file.
- URIMAP
- The name of the URIMAP that is associated with the WEBSERVICE.
- VALIDATION
- Indicates whether validation is enabled for the WEBSERVICE.
Values for the parameter are:
- WEBSERVICE
- The name of the WEBSERVICE.
- TOTAL_USE_COUNT
- Optional Parameter
The current use count for the WEBSERVICE.
Increment the use count for the named WEBSERVICE.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Resolve the HFS parts of a WEBSERVICE. The function takes a WEBSERVICE
which is in INSTALLING state to either INSERVICE or UNUSABLE state.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- EYECATCHER_ERROR
- FILE_NOT_FOUND
- INSUFFICIENT_STORAGE
- NOT_AUTHORIZED
- PIPELINE_ERROR
- PIPELINE_WRONG_MODE
- READ_ERROR
- SEVERE_ERROR
- SHELF_WRITE_ERROR
- VERSION_ERROR
- WEBSERVICE_NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Inquire on a WEBSERVICE resource.
Input Parameters
- WEBSERVICE
- The name of the WEBSERVICE.
- BINDING_BUF
- Optional Parameter
A buffer in which the WSDL binding value is returned.
- ENDPOINT_BUF
- Optional Parameter
A buffer in which the endpoint URI is returned.
- WSBIND_BUF
- Optional Parameter
A buffer in which the location of the Web service binding file in the
hierarchical file system (HFS) is returned.
- WSDLFILE_BUF
- Optional Parameter
A buffer in which the location of the optional Web service description
(WSDL) file in the hierarchical file system (HFS) is returned.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- NOT_AUTHORIZED
- SEVERE_ERROR
- WEBSERVICE_NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
- CONTAINER
- Optional Parameter
The name of the container for the target program's data.
- DATESTAMP
- Optional Parameter
The date stamp of the Web service binding file.
- LASTMODTIME
- Optional Parameter
The time at which the Web service binding file was last changed.
- PGMINTERFACE
- Optional Parameter
The type of interface used by the target program
Values for the parameter are:
- CHANNEL
- COMMAREA
- NOTAPPLIC
- PGMINTERFACE
- The type of interface used by the target program
Values for the parameter are:
- CHANNEL
- COMMAREA
- NOTAPPLIC
- PIPELINE
- Optional Parameter
The pipeline which owns the WEBSERVICE.
- PROGRAM
- Optional Parameter
The target program.
- STATE
- Optional Parameter
The current state of the WEBSERVICE.
Values for the parameter are:
- DISCARDING
- INITING
- INSERVICE
- UNUSABLE
- UPDATING
- TIMESTAMP
- Optional Parameter
The time stamp of the Web service binding file.
- TOTAL_USE_COUNT
- Optional Parameter
The total use count for the WEBSERVICE.
- URIMAP
- Optional Parameter
The name of the URIMAP that is associated with the WEBSERVICE.
- VALIDATION
- Optional Parameter
Indicates whether validation is enabled for the WEBSERVICE.
Values for the parameter are:
- WSADDR
- Optional Parameter
The address of the WEBSERVICE control block.
Resolve all WEBSERVICE resources for a given pipeline that are
in INITING state.
Input Parameters
- PIPELINE
- Optional Parameter
The pipeline for which WEBSERVICE resources are to be resolved.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Change the state of a WEBSERVICE resource.
Input Parameters
- VALIDATION
- The new validation state for the WEBSERVICE.
Values for the parameter are:
- WEBSERVICE
- The name of the WEBSERVICE.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- DUPLICATE
- NOT_AUTHORIZED
- SEVERE_ERROR
- WEBSERVICE_NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- PURGED
Start a browse operation on WEBSERVICE resources.
Output Parameters
- BROWSE_TOKEN
- The browse token for the browse operation.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- ABEND
- BROWSE_END
- DIRECTORY_ERROR
- DUPLICATE
- FILE_NOT_FOUND
- FREEMAIN_FAILURE
- INSUFFICIENT_STORAGE
- INVALID_BROWSE_TOKEN
- INVALID_FORMAT
- INVALID_FUNCTION
- LOCK_FAILURE
- LOOP
- NO_WEBS_INSTALLED
- NOT_AUTHORIZED
- PIPELINE_ERROR
- PIPELINE_NON_EXISTANT
- PIPELINE_WRONG_MODE
- READ_ERROR
- SEVERE_ERROR
- SHELF_WRITE_ERROR
- WEBSERVICE_IN_USE
- WEBSERVICE_NOT_FOUND
- RESPONSE
- Values for the parameter are:
- OK
- EXCEPTION
- DISASTER
- INVALID
- KERNERROR
- PURGED
[[ Contents Previous Page | Next Page Index ]]