Item name |
Required/Optional |
Use of variables |
Description |
Remarks |
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.
|
|
Path |
Optional |
Available |
Specify a relative path from the URL entered in [URL] of [Destination]. |
It will be URL encoded using the encoding entered or selected in [Encoding].
|
Encoding |
Optional |
Available |
Select or enter an encoding used for URL encoding.
When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8.
For more details, refer to “Supported Encodings” (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).
|
- Default value is “UTF-8” and it will be set when omitted.
|
Query parameter |
Optional |
- |
Specify names and values for query parameters to be linked with the URL.
Each query parameter can be operated with the following buttons.
- [Add]:
Add a query parameter.
- [Up]:
Move the selected query parameter upwards by one row.
- [Down]:
Move the selected query parameter downwards by one row.
- [Delete]:
Delete the query parameter.
|
It will be URL encoded using the encoding entered or selected in [Encoding].
|
Query parameter/Name |
Optional |
Available |
Enter the name of query parameter. |
- When omitted, the query parameter will not be concatenated to the URL.
|
Query parameter/Value |
Optional |
Available |
Enter the value of query parameter. |
|
Item name |
Required/Optional |
Use of variables |
Description |
Remarks |
Input source |
Required |
Not available |
Select an input source for request body.
- [Data]: (default)
The input data will be input source.
- [File]:
The file specified in [File path] will be input source.
|
|
Data format |
Required |
Not available |
Select data format of a request body.
- [XML]: (default)
Process as XML format.
MIME type of Content-Type header is “application/xml”.
- [JSON]:
Process as JSON format.
MIME type of Content-Type header is “application/json”.
- [Form]:
Process as form format.
MIME type of Content-Type header is “application/x-www-form-urlencoded”.
- [Multipart form]:
Process as multipart form format.
MIME type of Content-Type header is “multipart/form-data”.
|
- Displayed when [Data] is selected in [Input source].
- Input schema varies depending on the selected data format.
For more details on input schema, refer to “Input schema”.
|
File path |
Required |
Available |
Select or enter a file path of input source for a request body.
You can click [Browse] button to launch file chooser and find the file.
|
- Displayed when [File] is selected in [Input source].
MIME type of Content-Type header is judged and set automatically from the extension of file name. When unable to judge, it is set as “application/octet-stream”.
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.
|
Form settings |
Optional |
- |
Specify parameters of form for a request body.
Each parameter can be operated with the following buttons.
- [Add]:
Add a parameter.
- [Up]:
Move the selected parameter upwards by one row.
- [Down]:
Move the selected parameter downwards by one row.
- [Delete]:
Delete the parameter.
|
- Displayed when [Data format] is [Form].
|
Form settings/Name |
Optional |
Only environment variables are available |
Enter the form name. |
|
Multipart form settings |
Optional |
- |
Specify multipart for a request body.
Each part can be operated with the following buttons.
- [Add]:
Add a part.
- [Up]:
Move the selected part upwards by one row.
- [Down]:
Move the selected part downwards by one row.
- [Delete]:
Delete the part.
|
- Displayed when [Data format] is [Multipart form].
|
Multipart form settings/Name |
Optional |
Only environment variables are available |
Enter the part name of the multi part. |
|
Multipart form settings/Type |
Optional |
Not available |
Select the part type of the multipart.
- [String]: (default)
The string specified in input data will be the body of the part.
- [File]:
The data read from the file specified in input data will be the body of the part.
|
|
Put Content-Length header to part header for file type |
Optional |
Not available |
Select whether or not to put a Content-Length header to the part header, with the file size specified in the input data, when [Multipart form settings/Type] is [File].
- [Checked]:
Content-Length header will be put.
- [Not checked]:
Content-Length header will not be put.
|
- Displayed when [Data format] is [Multipart form].
|
Item name |
Required/Optional |
Use of variables |
Description |
Remarks |
Output destination |
Required |
Not available |
Select output destination of a response body.
- [Data]: (default)
Output to result data. Output in the format selected in [Data format].
- [File]:
Output to the file specified in [File path].
|
|
Data format |
Required |
Not available |
Select a data format of response body.
- [XML]: (default)
Process as XML format.
- [JSON]:
Process as JSON format.
- [Other]:
Process as text or binary format.
|
- Displayed when [Data] is selected in [Output destination].
- Output schema varies depending on the selected data format.
For more details on output schema, refer to “Output schema”.
|
File path |
Required |
Available |
Select or enter a file path of output destination for response body.
You can click [Browse] button to launch file chooser and find the file.
|
|
Remove invalid XML characters |
Optional |
Not available |
Select whether or not to remove invalid characters for XML automatically if that will be found while parsing JSON format data.
- [Checked]:
Invalid characters for XML will be removed.
- [Not checked]: (default)
Invalid characters for XML will not be removed.
|
- Displayed when [JSON] is selected in [Data format].
|
Redirect automatically |
Optional |
Not available |
Select whether or not to redirect automatically when a redirect destination is included in the response.
- [Checked]:
Redirect automatically.
- [Not checked]: (default)
Do not redirect automatically.
|
|
Error when response status code is 4xx or 5xx |
Optional |
Not available |
Select whether or not to make the processing an error when the response status code is “4xx” or “5xx”.
- [Checked]:
Processing will be an error.
- [Not checked]: (default)
Processing will not be an error.
|
|
Item name |
Required/Optional |
Use of variables |
Description |
Remarks |
Request header |
Optional |
- |
Specify HTTP headers to be included in a request.
Each request header can be operated with the following buttons.
- [Add]:
Add a request header.
- [Up]:
Move the selected request header upwards by one row.
- [Down]:
Move the selected request header downwards by one row.
- [Delete]:
Delete the request header.
|
|
Request header/Name |
Optional |
Available |
Enter the request header name. |
- When omitted, the request header is not included in request.
|
Request header/Value |
Optional |
Available |
Enter the request header value. |
|
Response header |
Optional |
- |
Specify header names to get from HTTP headers included in a response.
Each response header can be operated with the following buttons.
- [Add]:
Add a response header.
- [Up]:
Move the selected response header upwards by one row.
- [Down]:
Move the selected response header downwards by one row.
- [Delete]:
Delete the response header.
|
A response header is defined as a component variable with the name entered in [Name].
|
Response header/Name |
Optional |
Only environment variables are available |
Enter the response header name. |
- Case-insensitive.
- When omitted, it is not defined as a component variable.
- When there is a space / tab / line feed before or after the name, it will be trimmed and defined as a component variable.
|
Item name |
Required/Optional |
Use of variables |
Description |
Remarks |
Authentication |
Required |
Not available |
Select authentication method on sending a request.
- [None]: (default)
Authentication will not be performed.
- [Basic authentication]:
Basic authentication will be performed.
- [Digest authentication]:
Digest authentication will be performed.
- [WSSE authentication]:
WSSE authentication will be performed.
- [NTLM authentication]:
NTLM authentication will be performed.
- [Global resource]:
Authentication using global resource will be performed.
For more details on how to configure global resource, refer to the following.
|
|
User |
Optional |
Available |
Enter the user name used for authentication. |
- Displayed when [Basic authentication], [Digest authentication], [WSSE authentication], or [NTLM authentication] is selected in [Authentication].
|
Password |
Optional |
Available |
Enter the password used for authentication. |
- Displayed when [Basic authentication], [Digest authentication], [WSSE authentication], or [NTLM authentication] is selected in [Authentication].
|
Global resource |
Optional |
Not available |
Select a global resource used for authentication. |
- Displayed when [Global resource] is selected in [Authentication].
|
Element name |
Attribute name |
Description |
Remarks |
root |
- |
Root element wrapping JSON object. |
|
type |
Specify an attribute value that shows JSON type.
Attribute value |
Description |
object |
Shows JSON object type.
Example: An XML data of which the type attribute value of the root element is "object”
<root type="object">
<name type="string">Suzuki</name>
</root>
The above XML data is converted to the following JSON object.
{"name":"Suzuki"}
|
array |
Shows JSON array type.
Example: An XML data of which the type attribute value of the root element is “array”
<root type="array">
<element type="string">apple</element>
<element type="string">grape</element>
<element type="string">orange</element>
</root>
The above XML data is converted to an array type JSON object as follows.
["apple","grape”,"orange"]
|
|
- When there is no type attribute or the attribute value is empty, it is considered as object type.
|
JSON member name |
- |
Element that shows JSON member. |
|
type |
Specify an attribute value that shows JSON type.
Attribute value |
Description |
string |
Shows JSON string type.
Example: An XML data of which the type attribute value is “string”
<name type="string">Suzuki</name>
The above XML data is converted to a JSON member with string type value as given below.
{"name":"Suzuki"}
|
number |
Shows JSON numeric type.
Example: An XML data of which the type attribute value is “number”.
<age type="number">37</age>
The above XML data is converted to a JSON member with numeric type as follows.
{"age":37}
|
boolean |
Shows JSON boolean type.
Example: An XML data of which the type attribute value is “boolean”
<success type="boolean">true</success>
The above XML data is converted to a JSON member with boolean type as follows.
{"success":true}
|
object |
Shows JSON object type.
Example: An XML data of which the type attribute value is “object”
<name type="object">
<first type="string">Ichiro</first>
<last type="string">Suzuki</last>
</name>
The above XML data is converted to a JSON member with object type as follows.
{"name":{"first":"Ichiro","last":Suzuki"}}
|
array |
Shows JSON array type.
For a JSON array type element, specify “element” element of XML.
When the type of JSON array type element is object, specify an XML data with the schema showing JSON object to the child element of the “element” element, and the types is other than that, specify the value to the content of the “element” element.
Array type schema of JSON is as follows.
<JSON member name type="array">
<element type="attribute value showing JSON type">value</element>
:
</JSON member name>
Example: An XML data of which the type attribute value is “array”
<fruits type="array">
<element type="string">apple</element>
<element type="string">grape</element>
<element type="string">orange</element>
</fruits>
The above XML data is converted to a JSON member with array type as follows.
{"fruits":["apple","grape","orange"]}
|
null |
Shows JSON null type.
Example: An XML data of which the type attribute value is “null”
<name type="null"/>
The above XML data is converted to a JSON member with null type as follows.
{"name":null}
|
|
- When there is no type attribute, or the attribute value is empty, it is considered as string type.
- When the type attribute is "null", the element content is ignored.
|
element |
- |
Element that shows array element. |
|
type |
Specify a string that shows JSON type.
Specify the attribute value same as the type attribute of JSON member name.
|
- When there is no type attribute, or the attribute value is empty, it is considered as string type.
|
member |
- |
This is element specified for JSON member name when it is invalid for an element name of XML. |
|
type |
A string that shows JSON type is output.
Specify the attribute value same as the type attribute of JSON member name.
|
- When there is no type attribute, or the attribute value is empty, it is considered as string type.
|
name |
Specify the JSON member name.
Example: An XML data with a member element and the JSON member name is specified at the name attribute
<member type="string" name="1name">Suzuki</member>
The above XML data is converted to the following JSON member.
{"1name":"Suzuki"}
|
- When there is no type attribute, or the attribute value is empty, it is considered as string type.
|
Element name |
Attribute name |
Description |
Remarks |
request |
- |
|
|
body |
- |
|
|
form |
- |
|
|
parameter name of the form |
- |
Element that shows the form parameter name. |
- URL encoded using the encoding specified in [Encoding].
|
parameter |
- |
Element when a form parameter name is invalid for XML element name. |
- When a form parameter name is invalid for XML element name, set the form parameter name in parameter element.
|
name |
Input the form parameter name. |
- URL encoded using the encoding specified in [Encoding].
|
value |
- |
Input the form parameter value. |
- URL encoded using the encoding specified in [Encoding].
|
Element name |
Attribute name |
Description |
Remarks |
request |
- |
|
|
body |
- |
|
|
multipart |
- |
|
|
part name |
- |
Element that shows part name. |
- Encoded using the encoding specified in [Encoding].
|
part |
- |
Element when a part name is invalid for XML element name. |
- When the part name is invalid for XML element name, set the part in part element.
|
name |
Input the part name. |
- Encoded using the encoding specified in [Encoding].
|
mimeType |
- |
Input the MIME type of the part's Content-Type header. |
When [Multipart form settings/Type] is [String], remarks are as follows.
- When there is no mimeType element or the element content is empty, a Content-Type header is not put.
- The value specified in [Encoding] is set to charset parameter of a Content-Type header.
When [Multipart form settings/Type] is [File], remarks are as follows.
- When there is no mimeType element or the element content is empty, it will be judged automatically from the extension of the file name included in the path and will be input.
- When it is not possible to judge from the extension of the file name, it will be “application/octet-stream”.
|
value |
- |
Input a string for the body of the part. |
- Encoded using the encoding specified in [Encoding].
|
file |
- |
|
|
path |
- |
Input the file path for the part's body. |
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.
- The file name included in the path is encoded using the encoding specified in [Encoding].
|
Element name |
Attribute name |
Description |
Remarks |
root |
- |
Root element wrapping JSON object. |
|
type |
Attribute value showing JSON type is set.
Attribute value |
Description |
object |
Shows JSON object type.
Example: A JSON object consists of object type
{"name":"Suzuki"}
The above JSON object is converted to XML data as follows and output.
<root type="object">
<name type="string">Suzuki</name>
</root>
|
array |
Shows JSON array type.
Example: A JSON object consists of array type
["apple","grape”,"orange"]
The above JSON object is converted to XML data as follows and output.
<root type="array">
<element type="string">apple</element>
<element type="string">grape</element>
<element type="string">orange</element>
</root>
|
|
|
JSON member name |
- |
Element that shows JSON member. |
|
type |
Attribute value showing JSON type is set.
Attribute value |
Description |
string |
Shows JSON string type.
Example: A JSON member with string type value
{"name":"Suzuki"}
The above JSON member is converted to the following XML data and output.
<name type="string">Suzuki</name>
|
number |
Shows JSON numeric type.
Example: A JSON member with numeric type value
{"age":37}
The above JSON member is converted to the following XML data and output.
<age type="number">37</age>
|
boolean |
Shows JSON boolean type.
Example: A JSON member with boolean value
{"success":true}
The above JSON member is converted to the following XML data and output.
<success type="boolean">true</success>
|
object |
Shows JSON object type.
Example: A JSON member with object type value
{"name":{"first":"Ichiro","last":Suzuki"}}
The above JSON member is converted to the following XML data and output.
<name type="object">
<first type="string">Ichiro</first>
<last type="string">Suzuki</last>
</name>
|
array |
Shows JSON array type.
A JSON array type element is shown in “element” element.
When a JSON array type element is object type, an XML data with the schema that shows the JSON object is output to the child element of “element” element. When the type is other than that, the value will be output to the “element” element.
The schema is as follows.
<JSON member name type="array">
<element type="attribute value showing JSON type">value</element>
:
</JSON member name>
Example: A JSON member with array type value
{"fruits":["apple","grape","orange"]}
The above JSON member is converted to the following XML data and output.
<fruits type="array">
<element type="string">apple</element>
<element type="string">grape</element>
<element type="string">orange</element>
</fruits>
|
null |
Shows JSON null type.
Example: A JSON member with null type value
{"name”:null}
The above JSON member is converted to the following XML data and output.
<name type="null"/>
|
|
|
element |
- |
Element name that shows array element. |
|
type |
A string that shows JSON type is output.
The attribute value same as the type attribute of JSON member name is set.
|
|
member |
- |
Element name used when the JSON member name is invalid for XML element name. |
|
type |
A string that shows JSON type is output.
The attribute value same as the type attribute of JSON member name is set.
|
|
name |
A JSON member name is output.
Example: A JSON member with an invalid name for XML element name.
{"1name":"Suzuki"}
The above JSON member is converted to the following XML data and output.
<member type="string" name="1name">Suzuki</member>
|
|
Component variable name |
Description |
Remarks |
status_code |
HTTP status code of the response is stored. |
|
reason_phrase |
Text phrase related to the HTTP status code of the response is stored. |
|
error_response_body |
The response body with a response status code "4xx" or "5xx" is stored. |
|
message_category |
When an error occurs, the corresponding message code's category is stored. |
|
message_code |
When an error occurs, the corresponding message code is stored. |
|
message_level |
When an error occurs, the corresponding message code's severity is stored. |
|
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.
|
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 [File path] is directory. |
Enter a file path in [File path]. |
PathIsNotAbsoluteException |
The path entered in [Path] or [File path] is a relative path. |
Enter an absolute path in [Path] or [File Path]. |
PathIsRequiredException |
The path to show the file of data to be stored in the part's body is not set in the input data while sending multipart form data. |
Check whether the path is set in path element of the input data. |
RestServerException |
A response with status code “5xx” was returned from the HTTP server. |
Referring to the contents of error message, check the status of the HTTP server specified in [Destination] or the contents of the request. |
RestClientException |
A response with status code “4xx” was returned from the HTTP server. |
Referring to the contents of error message, check the path entered in [Path] or the contents of the request. |
org.apache.http.client.ClientProtocolException |
An error occurred during sending request. |
Check the contents of the error message. |
org.apache.http.conn.HttpHostConnectException |
Unable to connect to the HTTP server or the proxy server. |
Check whether it is possible to connect to the destination HTTP server or the proxy server. |
org.apache.http.conn.ConnectTimeoutException |
A timeout has occurred while connecting to the HTTP server or the proxy server. |
Check the setting of [Connection timeout] in [Destination]. |
java.net.SocketTimeoutException |
After connecting to the HTTP server and sending the request, a timeout has occurred before receiving the response. |
Check the setting of [Response timeout] of [Destination]. |
javax.json.stream.JsonParsingException |
An error occurred while processing the response body as JSON format. |
Referring to the contents of error message, check the settings of [Response settings] and the contents of the response. |
javax.json.stream.JsonGenerationException |
An error occurred while converting the input data to JSON. |
Check the contents of input data. |