Call web service

The Call web service workflow action allows the workflow to make a call to a SOAP web service method.

To use the workflow action:

Locate the action in Workflow Actions Toolbox (located on the left hand-side);

Click on the Category listings to reveal the actions; OR
Search for the action using a keyword.

Select the action, drag it onto the design canvas and drop it onto a design pearl.

Alternatively

Left-clicking the pearl, mouse-over Insert Action and then the Categories to reveal the actions, click the required action from the list.

To change the settings used by the action:

On the action’s title click the down arrow to activate a drop-down
Select Configure; OR
Double-click the action's icon.

For more information on the other options in the drop-down, please refer to the Getting started with the Nintex Workflow designer.

Action Settings

URL

A mandatory field that represents the full 'URL to the WSDL definition of the SOAP web service to call'. Once a URL has been entered, click the Refresh button on the Web method to select from the available Web methods. References can also be inserted using the Inserting reference fields feature.

Username

The username (including domain) used when authenticating against the web service. This is an optional setting, however if left blank the web service must be open to anonymous access.

Password

The password for the username above when authenticating against the web service. If left blank, the web service must be open to anonymous access.

Web Method

The web methods that are available for the web service.

Editor mode

The Editor mode defines the values to be sent to the web service. The message configuration depends on the parameters required by the selected web service method.

SOAP Builder: Use the SOAP Builder if the web service method only required parameters of 'simple' data types. An input form is displayed to allow these values to be provided. Note: If the web service method requires complex parameters, the SOAP Builder form cannot be displayed and a single text box to edit the XML of the SOAP message directly is provided.
SOAP Editor: Use the SOAP Editor to directly edit the XML message when the selected web service method requires complex data types.
Note: Editing the SOAP message manually requires some advanced knowledge of web services.

To pass the byte array of the document under workflow, type [FileData] into any input field. At runtime Nintex Workflow will base64 encode the file and pass that as the value.

For more information on the SOAP standard please refer to http://www.w3.org/TR/soap12-part0.

Web service input

Encode inserted tokens

Specifies whether inserted tokens (workflow variables, list item properties, etc) should be encoded to ensure they are valid for sending to the web service.

Web service output

Default value

The default value can be used for a single return value from a web service method.

Store result in
This list contains the workflow variables that can be used to store the simple type result of the call.
Result processing
Force top level XML node: Determines whether the result should be wrapped in a top level XML element called <xml>. This is useful if the result from the web service is not XML or is an XML fragment with no root node.
XML Transform: Allows an XSL transform to be defined. This transform will be applied to the web service results before they are stored in the workflow variable.

Specify elements

Allow the workflow to store specific values from a web service response.

To specify an element:

1. Click on Select element to browse the response format and select a value. Click Apply.

2. Specify a workflow variable to store the value of the element selected.