« Request Type Descriptions   |   Embedding Environment Variable Values »

External Mode

This manual is in pilot operation.

What is External Mode?

External Mode is a mode in which the detailed request and response data exchanged with the server is provided (for requests) or received (for responses) via separate files from the XML files used for requests and responses. In contrast, the typical usage where the detailed content is written within the XML file is referred to as "Standard Mode."

Here, "detailed content" refers to the following:

Request Details

The "Request Content" marked with the <contents> tag.

Response Details

The "Returned Content" marked with the <returned-contents> tag.

In Standard Mode, special characters in detailed content must be escaped, requiring conversion between special characters and escape sequences. External Mode eliminates the need for such conversion, making it more convenient.

How to Use External Mode

When running the Requester in External Mode, please keep the following three points in mind:

1. Command Line Parameter Specification

When executing the Requester, specify the parameter "-external true" on the command line. This enables execution in External Mode.

2. Specifying "Request Content" in the Request XML

Normally, request content (the data marked with the <contents> tag) is written directly in the XML according to the request type. In External Mode, however, write the request content in a separate file (without escaping). In the "Request Content" of the Request XML, specify the filenames for the request and returned content files as follows:

<contents>
  request-contents-file=(request content filename)
  returned-contents-file=(returned content filename)
</contents>

Use / as the path separator in filenames instead of \. For example:

<contents>
  request-contents-file=C:/fusionplace/inbox/request1.csv
  returned-contents-file=C:/fusionplace/outbox/request2.csv
</contents>

Filenames can also be specified using relative paths. In that case, the paths are interpreted relative to the current folder when the Requester is executed.

Some request types do not require "Request Content." In such cases, the line starting with "request-contents-file=" can be omitted. Similarly, if "Returned Content" is not needed, the line starting with "returned-contents-file=" can be omitted.

3. About "Returned Content" in the Response XML

When the Requester is executed in External Mode, returned content is handled as follows:

  1. If "returned-contents-file" is specified in the "Request Content" section of the Request XML, the returned content will be written to that file. In the "Returned Content" section of the Response XML, the returned content filename is set as follows:

    returned-contents-file = (returned content filename)

    The (returned content filename) is given as an absolute path.

  2. If returned-contents-file is not specified in the "Request Content" section of the Request XML, the returned content is not output anywhere. The "Returned Content" section of the Response XML will be empty.

  3. If "hex2bin" is specified after the returned content filename, separated by a comma, the returned content is assumed to be in hexadecimal format. It will be converted to binary format and saved to the specified file.

    returned-contents-file = (returned content filename), hex2bin

    hex2bin can be written in uppercase or lowercase. Spaces can also be placed before or after the comma.