Execute Web Service

Operation Name

Execute Web Service

Function Overview

Execute web service.

Data Model

XML type.

For more details on input/output schema, refer to “Schema”.

Properties

For details on use of variables, refer to “Variables”.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.
Input data	Optional	Not available	Select a component on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description
Destination	Required	Not available	Select a global resource. For details about how to configure global resource, refer to “Global Resource Properties”. [Add]: Add a new global resource. [Edit list]: Global resource settings can be edited in “Edit resource list” screen.
Service	Required	Not available	Select a service to execute. The services defined in the selected [Destination] are displayed.
Port	Required	Not available	Select a port to execute. The ports corresponding with the selected [Service] are displayed.
Operation	Required	Not available	Select an operation to execute. The operations corresponding with the selected [Port] are displayed.
Read attribute information from WSDL	Optional	Not available	Select whether or not to read attribute information from WSDL. [Checked]: Read attribute information from WSDL and reflect it in the input/output schema. [Not checked]: (default) Do not read attribute information from WSDL.

Property actions

Item name	Description	Remarks
View WSDL	Start previewer to view the resource (WSDL) specified in [Destination].

HTTP auth

Item name	Required/Optional	Use of variables	Description	Remarks
Authentication	Required	Not available	Select which authentication to perform when executing web service. [Use destination setting]: (default) Use authentication setting set in the destination global resource. [None]: Do not perform particular authentication. Authentication will not be performed. [Basic authentication]: Perform particular Basic authentication. Basic authentication using user name and password will be performed.
User name	Optional	Available	Enter the user name used for authentication.	Enabled when [Basic authentication] is selected in [Authentication].
Password	Optional	Available	Enter the password used for authentication.	Enabled when [Basic authentication] is selected in [Authentication].

Web service auth

Item name	Required/Optional	Use of variables	Description	Remarks
Authentication	Required	Not available	Select whether or not to perform authentication using WS-Security when executing web service. [None]: (default) Do not perform authentication using WS-Security. [Plaintext password authentication]: Perform authentication using WS-Security. User name and password will be embedded in SOAP header, password authentication by plaintext will be performed.	For details on WS-Security, refer to “WS-Security 1.0” (http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0.pdf).
User name	Optional	Available	Enter the user name used for authentication.	Enabled when [Plaintext password authentication] is selected in [Authentication].
Password	Optional	Available	Enter the password used for authentication.	Enabled when [Plaintext password authentication] is selected in [Authentication].

Cookie

Item name	Required/Optional	Use of variables	Description	Remarks
Send saved Cookie to server	Optional	Not available	Select whether or not to send saved Cookie. [Checked]: (default) Send saved Cookie when executing Web service. [Not checked]: Do not send saved Cookie when executing Web service.	Cookie is saved automatically when executing Web service.

SOAP header

Item name	Required/Optional	Use of variables	Description	Remarks
SOAP header	Optional	Available	Enter the SOAP header item to send.	Enter that from child element (header item) of SOAP Header element. When describing elements or attributes which are modified with name spaces, describe also the corresponding name space declarations. When executing [Web service authentication], the header item entered in this property is added after a header item of the authentication information. For details on header attributes defined in SOAP, refer to “mustUnderstand Attribute and actor Attribute of SOAP Header”.

Property actions

Item name	Description	Remarks
Analyze WSDL	Display the SOAP header of SOAP envelope in the Web service specified in [Destination], in [SOAP header].

Manual settings

Item name	Required/Optional	Use of variables	Description	Remarks
Define SOAP envelope manually	Optional	Not available	Select whether or not to define SOAP envelope manually. [Checked]: Define SOAP envelope manually. [Not checked]: (default) Do not define SOAP envelope manually.	When [Define SOAP envelope manually] is checked, [Web service auth] and [SOAP header] are not used.
SOAP envelope	Optional	Available	Enter SOAP envelope.	Enabled when [Define SOAP envelope manually] is checked.

Property actions

Item name	Description	Remarks
Analyze WSDL	Display the SOAP envelope in the Web service specified in [Destination], in [SOAP envelope].

Attachments to send

Item name	Required/Optional	Use of variables	Description	Remarks
Attachment	Optional	-	Specify attachment file paths. Each column can be operated with the following buttons. [Add]: Add a column. [Up]: Move the selected column upwards by one row. [Down]: Move the selected column downwards by one row. [Delete]: Delete the column.
Attachments/File path	Required	Available	Enter the attachment file path.	For more details on attachment file name, refer to “Attachment File Name to Send”. Specify the file path as an absolute path of DataSpider File System. Except for the path separator “/”, restricted characters of DataSpider File System cannot be used.
Attachments/Content ID	Optional	Available	Enter the content ID of attachment.	Auto-generated when omitted.

Attachments to receive

Item name	Required/Optional	Use of variables	Description	Remarks
Receive attachment	Optional	Not available	Select whether or not to receive attachments. [Checked]: (default) Receive attachments of message. [Not checked]: Do not receive attachments of message.
Attachment store	Required	Available	Enter the directory where to store attachments. You can click [Browse] button to launch the directory chooser and find the directory.	Default value is “/tmp”. Enabled when [Receive attachment] is checked. When ASCII character of restricted characters of DataSpider File System or tab character is included in attachment file name, that will be converted to “_” (underscore) and output. For more details on attachment file name, refer to “Received Attachment File Name”. Specify the file path as an absolute path of DataSpider File System. Except for the path separator “/”, restricted characters of DataSpider File System cannot be used.
When file with same name exists in attachments	Required	Not available	Select a behavior when the file with same name exists in attachments. [Overwrite]: (default) Overwrite file. [Append sequence number]: Append sequence number as “<file name>_1.csv”. When the file has extension, sequence number is put at before the extension.	Enabled when [Receive attachment] is checked.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Schema is different depending on the type of Web service.

For namespaces other than default, prefixes in the format of ns0, ns1, ns2, ... are output.

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
attachment_id	The content ID of received attachment is stored.	When receiving multiple attachments, IDs are output delimited with comma (,) and the order corresponds with [attachment_path].
attachment_path	The path of received attachment is stored.	When receiving multiple attachments, paths are output delimited with comma (,) and the order corresponds with [attachment_id].
message_category	When an error occurs, the corresponding message code's category is stored.	Default value is null.
message_code	When an error occurs, the corresponding message code is stored.	Default value is null.
message_level	When an error occurs, the corresponding message code's severity is stored.	Default value is null.
error_type	When an error occurs, the error type is stored.	Default value is null. The error type will be in the following format. Example: “java.io.FileNotFoundException” The contents that will be stored may vary depending on DataSpider Servista versions.
error_message	When an error occurs, the error message is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace	When an error occurs, the error's trace information is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

mustUnderstand Attribute and actor Attribute of SOAP Header

Specifications about mustUnderstand attribute and actor attribute of SOAP entered in [SOAP header] are as follows.

When header item has no mustUnderstand attribute, “mustUnderstand=0” is given.

When mustUnderstand attribute value specified in header item is null or other than “1”, attribute value would be “0”.

When header item has no actor attribute, “actor="http://schemas.xmlsoap.org/soap/actor/next"” is given.

When actor attribute value specified in header item is null, attribute value would be “http://schemas.xmlsoap.org/soap/actor/next”.

Attachment File Name to Send

Specifications about attachment file name to send are as follows.

The part after the last path separator “/” of the file path specified in [Attachments/File path] is used as file name.

File name is set to the filename parameter of Content-Disposition header in MIME multipart, in the format defined in RFC2231.

File name is set to the Content-Location header in MIME multipart.

File name is not set to the name parameter of Content-Type header in MIME multipart.

Received Attachment File Name

Specifications about received attachment file name are as follows.

Name for received attachment file is looked up in the following order and the one found first is applied.
1. filename parameter of Content-Disposition header in MIME multipart
2. The string after the last slash (/) of the Content-Location header value in MIME multipart
3. name parameter of Content-Type header in MIME multipart
4. The content ID of received attachment
When none of them is found, a unique string will be auto-generated and applied.

Specification Limits

Supported SOAP version is 1.1.

Supported WSDL version is 1.1.

It conforms to WS-I Basic Profile 1.0.

Only Web services using http or https protocol are executable. Other protocols like smtp are not supported.

Send and receive of Cookie can be performed only in Web services where the host of endpoint URL is same.

Array of WSDL is not deployed in Mapper schema.

The supported attachment format is MIME multipart message of SOAP Messages with Attachments(SwA).

Major Exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name: []	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition is not found. Name: [<global resource name>]	The resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException Required item of the resource is not specified. :<property name>	[<property name>] of [Destination] is not specified.	Specify [<property name>] of [Destination].
InvalidPropertyConfigurationException <property name> is not specified.	[<property name>] is not specified.	Specify [<property name>].
FileIsDirectoryException	The path entered in [WSDL file] of [Destination] is directory.	Enter a file path in [WSDL file] of [Destination].
DataProcessingException	Failed to execute the Web service.	When executing a script in debug mode, the SOAP envelope sent to the execution log is output. Check whether the SOAP envelope is sent in a correct format.
DataProcessingException java.io.FileNotFoundException	Failed to read the WSDL file.	Check [WSDL file] specified in the [Destination].
java.io.FileNotFoundException	The file specified in [WSDL file] of [Destination] does not exist.	Check [WSDL file] of [Destination].
org.apache.axis.AxisFault (401)Unauthorized	Authentication with the server has failed while executing the Web service.	Check [Authentication][User name][Password].
InvalidSOAPHeaderException	Failed to create a SOAP header while executing the Web service.	Check the content entered in [SOAP header].

Notes

SSL connection failure
When SSL connection is performed to a Web server where the certificate is not imported from the key store referred by DataSpiderServer, an error such as javax.net.ssl.SSLHandshakeException might occur and the connection fails.
For details on how to import a certificate to key store, refer to "Import Certificate".