Web services lookup

Description

The Web Services Lookup transform performs a Web Services lookup using the Web Services Description Language (WSDL).

Options

Option Description

Option	Description
Transform Name	Name of the transform this name has to be unique in a single pipeline.
URL	The location of the WSDL document. This is either an `http://` or `https://` URL, or a file, for example `${PROJECT_HOME}/wsdl/service.wsdl`. A file can be on any file system Hop can read: a local folder, a `file://` URL, S3, Azure, a named VFS connection and so on. Variables are resolved, both in the dialog and when the pipeline runs.
Browse… (button)	Select a WSDL file. Its location is put in the URL field and the WSDL is loaded, as with the Load button. A file in your project folder is kept relative to `${PROJECT_HOME}`, so the pipeline keeps working when the project moves.
Load (button)	The load button loads the WSDL at the specified URL and tries to automatically populate the input and output tabs and fields. NOTE: If this doesn’t work, you can still try to manually specify the input and output fields using the "Add Input" and "Add Output" buttons.
Operation	The operation of the web service to call.
Operation request name (optional)	On occasion the WSDL gives back the wrong operation request name to put in the body. Put in the correct one (as expected by the service) here.
The number of rows per call	The number of rows to send with each WSDL call
Pass input data to output	If you disable this, the input will be eaten and only the WSDL output will be passed along to the next transforms. v2.x/3.x compatibility mode We improved the parsing engine of the 3.x engine dramatically. For compatibility reasons, we kept the old engine around to make sure older transforms would still work OK.
Repeating element name	Specify the name of the repeating element in the output XML (if any).
Return the complete reply from the service as a String	Don’t parse the reply of the service: pass the complete SOAP reply on as a String. You need to specify a single String output field to receive it.
HTTP authentication	Here you can put the username and password if these are required for the web service.
Proxy to use	Here you can optionally put the proxy host and port information.
Add Input / Add Output	These buttons will allow you to manually specify the input and output specifications of the WSDL service. Note: The data of the input fields can be escaped by the Calculator transform and the function "Mask XML content from string A"

Transform Name

Name of the transform this name has to be unique in a single pipeline.

URL

The location of the WSDL document. This is either an http:// or https:// URL, or a file, for example ${PROJECT_HOME}/wsdl/service.wsdl. A file can be on any file system Hop can read: a local folder, a file:// URL, S3, Azure, a named VFS connection and so on. Variables are resolved, both in the dialog and when the pipeline runs.

Browse… (button)

Select a WSDL file. Its location is put in the URL field and the WSDL is loaded, as with the Load button. A file in your project folder is kept relative to ${PROJECT_HOME}, so the pipeline keeps working when the project moves.

Load (button)

The load button loads the WSDL at the specified URL and tries to automatically populate the input and output tabs and fields. NOTE: If this doesn’t work, you can still try to manually specify the input and output fields using the "Add Input" and "Add Output" buttons.

Operation

The operation of the web service to call.

Operation request name (optional)

On occasion the WSDL gives back the wrong operation request name to put in the body. Put in the correct one (as expected by the service) here.

The number of rows per call

The number of rows to send with each WSDL call

Pass input data to output

If you disable this, the input will be eaten and only the WSDL output will be passed along to the next transforms. v2.x/3.x compatibility mode We improved the parsing engine of the 3.x engine dramatically. For compatibility reasons, we kept the old engine around to make sure older transforms would still work OK.

Repeating element name

Specify the name of the repeating element in the output XML (if any).

Return the complete reply from the service as a String

Don’t parse the reply of the service: pass the complete SOAP reply on as a String. You need to specify a single String output field to receive it.

HTTP authentication

Here you can put the username and password if these are required for the web service.

Proxy to use

Here you can optionally put the proxy host and port information.

Add Input / Add Output

These buttons will allow you to manually specify the input and output specifications of the WSDL service. Note: The data of the input fields can be escaped by the Calculator transform and the function "Mask XML content from string A"

WSDL files and imports

A WSDL can import other WSDL documents (<import location="…">) and XML schemas (<xsd:import schemaLocation="…">, <xsd:include>). A relative location is looked up next to the document that names it, on the same file system or web server as that document: a WSDL on S3 finds its imports on S3. An imported document can import others in turn.

HTTP authentication is used to fetch the WSDL over http:// or https://, its imports from the same host, and to call the service itself. It is not sent to any other host a WSDL imports from.

Input and output fields

After loading the WSDL and selecting an operation, the input and output tabs list the fields of the request and the reply. When a WSDL can’t be loaded, you can fill them in yourself with "Add Input" and "Add Output", for example from a request and reply you captured with a tool like SoapUI.

Column Description

Column	Description
Name	The name of the field in the Hop pipeline: the input field that provides the value, or the output field that receives it.
WS Name	The name of the XML element in the SOAP request or reply, without its namespace prefix.
WS Type	The XML schema type of the element: `string`, `int`, `integer`, `short`, `boolean`, `date`, `time`, `datetime`, `double`, `float`, `base64Binary` or `decimal`. Dates, times and booleans are formatted to match this type in the request.

Name

The name of the field in the Hop pipeline: the input field that provides the value, or the output field that receives it.

WS Name

The name of the XML element in the SOAP request or reply, without its namespace prefix.

WS Type

The XML schema type of the element: string, int, integer, short, boolean, date, time, datetime, double, float, base64Binary or decimal. Dates, times and booleans are formatted to match this type in the request.