Invoke Web Service operation

A web service client that invokes a web service operation and saves the response as process data, including attachments. Invoke Web Service interacts with web services by sending and receiving SOAP messages. For authentication, this operation supports HTTP Basic Authentication and HTTPS authentication.

This operation supports sending inline MIME, SwaRef, and base64, and MTOM attachments with SOAP messages using the WS-Attachment protocol. DIME attachments and MTOM attachments sent as base64-encoded byte array that are embedded in the SOAP XML are not supported.

Use the Invoke Web Service operation to call a web service to retrieve data that your process requires. For example, a purchase order process uses a web service to retrieve the name of a customer, their mailing address, and other billing information.

For information about the General and Route Evaluation property groups, see Common operation properties.

Web Service Options properties

Properties for specifying the web service operation to invoke.

Options

A value that represents the options to send to the web service for invoking a service operation.

Use the Web Service Settings dialog box to specify the value. (See About Web Service Settings.) Click the ellipsis button  to display the dialog box.

Web Service Response properties

Properties for saving the web service response message.

Response

The location to save the response message that the web service returns as a result of the invocation request. The data type is xml. Click the ellipsis button  to open XPath Builder to create the XPath expression that resolves to the location.

Attachments

The location in the process data model to save documents that are attached to the response message. The data type is list, which holds document values.

CDATA List

The location to save text that is located inside CDATA sections in the web service response. The data type is list which holds document values. The list contains a document value for each CDATA section in the web service response.

When you save CDATA selections in a list of documents, you do not have to parse the web service response to access the text. For example, when LiveCycle web services return XML code in their response, it is located in a CDATA section. Other web services can include other types of data inside CDATA sections.

Exceptions

This operation can throw these exceptions: WebServiceConfigurationException, WebServiceInvocationException, and WebServiceResponseParsingException.

Web Service exceptions

The Web Service service provides the following exceptions for throwing exception events.

WebServiceConfigurationException

Thrown when there is a problem with the configuration of the Web Service Options properties.

WebServiceInvocationException

Thrown when an error occurs when the web service is called.

WebServiceResponseParsingException

Thrown when an error occurs when parsing the response message that the web service returns.

// Ethnio survey code removed