Execute Web Service Action

Declaration

<AMEXECUTEWEBSERVICE WSDLURL="text" METHODNAME="text" RESULTVARIABLE="text"><Argument ArgType="text" ArgValue="text" /></AMEXECUTEWEBSERVICE>

See Also

Automating Web Service Execution, Send Email, Get Email Action, HTTP download Action, HTTP Post/Put Action

Description

Executes a web service call using the provided WSDL URI (Uniform Resource Identifier) and parameters.

Practical Usage

Provides an automated means of calling a Web service method by way of a WSDL document or URI. This action supports variables, static values and standard parameter types (such as strings and numbers) as well as support for structure information. Data can be returned into a corresponding structure or a specified AutoMate variable.

Parameters

General Tab

WSDL URI

Text, Required
MARKUP: WSDLURL="http://example.com/services/stockquote/wsdl"

Specifies the location to WSDL (Web Services Description Language) URL or a file location to a WSDL file. After entering the WSDL URL or file, clicking the Go button to query available WSDL methods.

Web Service Type

Text, Required
MARKUP: TYPENAME="StockQuote"

Specifies the web service class which contains the available methods. After specifying a WSDL location in the WSDL URI parameter, clicking the Go button will attempt to query available Web Service Types specified in the WSDL URL or file. Upon a successful query, all discovered Web Service Types will be populated into the Web Service Type field. Clicking the down arrow corresponding to this field will display a full list of queried type names in which to select from.  

Method

Text, Required
MARKUP: METHODNAME="InvertStringCase"

Specifies the WSDL method (or operation) to invoke. Upon selection of an available class as specified under the Web Service Type parameter, all discovered methods relating to that class will be populated into the Method field. Clicking the down arrow corresponding to this field will display a full list of queried method names in which to select from.  

Populate variable with return value

Text, Required
MARKUP: RESULTVARIABLE="theVar"

Specifies the name of an existing variable to be populated with the return value of the selected method.

Create structure with returned complex type

Text, Optional
MARKUP: RESULTSTRUCTURE="theStructure"

Specifies the name of the structure created by the user. A Web Service call may require the use of one or more structures as parameters. If such structures are required, the user must initially create them in prior steps during design time using the ‘Define Type’ and ‘Create Object’ action. The ‘Define Type’ action defines a custom object type or types defined in a Web service. The ‘Create Object’ action creates an Automate Object from defined custom type(s) defined by the ‘Define Type’ action. The structure contents can then be defined in this parameter with the returned user defined object’s properties. Structures can be saved to an AutoMate variable which can be specified in this parameter.

 

Arguments Tab

Type

Text, Required
MARKUP: ARGTYPE="string"

Specifies the WSDL method argument type. If clicking the Go button accomplished a successful query of the WSDL document/URI and one or more methods were selected from the Method field, this column becomes pre-populated with any corresponding parameter types in the order in which they were selected. This allows the user to simply enter the necessary parameter values under the Value column.

Value

Text, Required
MARKUP: ARGVALUE="Hello"

Specifies the value to enter corresponding to the argument type populated under the Type column.

 

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

 

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMEXECUTEWEBSERVICE WSDLURL="http://www.webservicex.net/stockquote.asmx?WSDL" TYPENAME="StockQuote" METHODNAME="GetQuote" RESULTVARIABLE="returnedData"><Argument ArgType="String" ArgValue="Goog" /></AMEXECUTEWEBSERVICE>