Web Service HTTP Client Service (com.ibi.agents.XDWSHttpClientAgent)

Syntax:

com.ibi.agents.XDWSHttpClientAgent

iIT Service Object:

misc: WS HTTP Client Agent

Description:

This service executes a web service through an HTTP Client provider and allows a transformation to be applied to the response document.

Parameters:

Parameter	Description
End point *	The location where the web service has been deployed.
SOAP Action	Value of the SOAPAction header for HTTP.
Content-Type	Value of the Content-Type MIME Header. The default value is: text/xml
User ID	User ID for Basic Authentication challenges.
Password	Password for Basic Authentication challenges.
Timeout	The timeout value in seconds. The default value is: 0
Header	The header of the web service message. This value can be a file name, transform, or actual data with SREG, XPATH, and so on.
Body	The body of the web service message. Can be a file name, transform, or actual data with SREG, XPath, and so on. The default value is: _flatof(false)
Fault Transform	Transformation to apply when a web service fault occurs.
Strip SOAP Envelope	If set to true, then the SOAP envelope from the response document is removed. By default, this parameter is set to false. For more information on the behavior and usage of this parameter, see the description that follows this table.
Response Transform	Transformation to apply for the web service response document.
HTTP Client Provider *	The HTTP Client provider that manages connections for this web service agent.

Edges:

The following table lists the available line edges for the Web Service HTTP Client Service (com.ibi.agents.XDWSHttpClientAgent).

Line Edge	Description
OnError	Error
OnSuccess	Success
OnFailure	Failure
OnCustom	OnError OnSuccess OnFailure fail_connect fail_operation fail_security fail_parse fail_timeout cancelled Standard SOAP fault

Strip SOAP Envelope Parameter

The Strip SOAP Envelope parameter moves namespaces to the payload node when a SOAP response is received. For example, assume that the target web service returns the following message to the service:

<?xml version="1.0" encoding="UTF-8" ?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:somens="http://somens.com">
      <SOAP-ENV:Body>
          <somens:payload>Hello</somens:payload>
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

If set to true, then the Strip SOAP Envelope parameter cuts the child of the <SOAP-ENV:Body> element, which in this example, is <somens:payload>. The result is not, by itself, a well-formed XML document because the xmlns attribute that declares the somens namespace prefix is lost during the cut.

Enabling the Strip SOAP Envelope parameter causes the service to ascend the XML tree looking for namespace declarations and copies these attributes to the payload node. For example, after the SOAP envelope is removed, the response document has the following structure:

<somens:payload xmlns:somens="http://somens.com">Hello</somens:payload>