What Is Requester

« Excel-Link | Request File Format »

This manual is in pilot operation.

Table of Contents

What Is Requester

Requester is a tool that executes bulk processing and scheduled processing of large volumes of data from the command line. Using Requester, you can perform the following operations.

Requester Program File

The Requester program file is bundled in the zip file that contains the fusion_place installer. The file name is as follows.

fusion_place-requester-n.n.jar

n.n represents the version number.
The file extension jar indicates that this file contains a Java program.

Execution Environment for Requester

Requester can be executed on any computer that can access the fusion_place server via URL, even if it is not running on the fusion_place server itself ^[1].

Requester communicates with the fusion_place server using [Web-API]. [Web-API] is one of the "Client Programs" defined in the fusion_place License Agreement. Therefore, when running Requester and other programs that use [Web-API] simultaneously, each program must use a different User Account.

How to Execute Requester

Requester reads a "Request File", requests processing from the fusion_place server, and writes the processing results to a "Response File". Both the Request File and Response File are XML-formatted text files. To execute Requester, enter a command similar to the following at the command prompt.

java -Xms256m -Xmx1024m -jar fusion_place-requester-n.n..jar -url http://:***/fusionplace -user **** -pass **** -external false < request.xml > response.xml

The command-line parameters are explained below.

Parameter Description

Parameter	Description
java	Instructs execution of the `java.exe` program. If the path to `java.exe` is not specified in the `PATH` environment variable, specify the full path including the folder.
-Xms256m -Xmx1024m	Specifies the amount of memory used for program execution. `-Xms` specifies the initial memory size and `-Xmx` specifies the maximum memory size. The suffix `m` indicates MB. In this example, the initial memory size is 256 MB and the maximum memory size is 1024 MB (1 GB).
-jar fusion_place-requester-n.n..jar	Specifies the Requester file name `fusionplace-requester-n.n..jar` to execute following `-jar`. Replace `n.n` with the version number.
-url http://***:**/fusionplace	Specify the URL of the fusion_place server following `-url`. This is the same URL configured as the connection destination when accessing the fusion_place server from the computer running Requester using [Excel-Link] or similar tools.
-user ** -pass **	Specify the fusion_place User Account Name for `-user` and the password for `-pass`. For example, if the User Account Name is `admin` and the password is `jugemu`, specify as follows. + -user admin -pass jugemu
-external false	Specify `-external true` to run in External Mode, or `-external false` to run in Normal Mode. If not specified, Normal Mode is used.
< request.xml	Specify the Request File name following `<`. In this example, the file name is `request.xml`, but any name may be used. If the file is not in the current folder, include the path. + NOTE: Requester reads requests from standard input.
> response.xml	Specify the Response File name following `>`. In this example, the file name is `response.xml`, but any name may be used. If you want to create the file outside the current folder, include the path. + NOTE: Requester writes responses to standard output. Messages displayed by Requester during processing are written to standard error output.

java

Instructs execution of the java.exe program. If the path to java.exe is not specified in the PATH environment variable, specify the full path including the folder.

-Xms256m -Xmx1024m

Specifies the amount of memory used for program execution. -Xms specifies the initial memory size and -Xmx specifies the maximum memory size. The suffix m indicates MB. In this example, the initial memory size is 256 MB and the maximum memory size is 1024 MB (1 GB).

-jar fusion_place-requester-n.n..jar

Specifies the Requester file name fusionplace-requester-n.n..jar to execute following -jar. Replace n.n with the version number.

-url http://*****:****/fusionplace

Specify the URL of the fusion_place server following -url. This is the same URL configured as the connection destination when accessing the fusion_place server from the computer running Requester using [Excel-Link] or similar tools.

-user **** -pass ****

Specify the fusion_place User Account Name for -user and the password for -pass. For example, if the User Account Name is admin and the password is jugemu, specify as follows.

+ -user admin -pass jugemu

-external false

Specify -external true to run in External Mode, or -external false to run in Normal Mode. If not specified, Normal Mode is used.

< request.xml

Specify the Request File name following <. In this example, the file name is request.xml, but any name may be used. If the file is not in the current folder, include the path.

+ NOTE: Requester reads requests from standard input.

> response.xml

Specify the Response File name following >. In this example, the file name is response.xml, but any name may be used. If you want to create the file outside the current folder, include the path.

+ NOTE: Requester writes responses to standard output. Messages displayed by Requester during processing are written to standard error output.

In addition to the above, the following options can be specified. Specify them after -jar ****** and before specifying the request and response.

Option Description

Option	Description
-Djava.net.useSystemProxies=true (fusion_place >= 14.1)	When a PAC file is specified in Windows proxy settings under "Automatic proxy setup > Use setup script", specifying this option allows Requester to automatically obtain the proxy server.
-encoding ****	Specifies the encoding applied to the Response File. Available values vary depending on the OS environment. Commonly used values are `UTF-8` and `Windows-31J` (Windows extension of Shift JIS). For example, to specify `Windows-31J`, use the following. + -encoding Windows-31J + If not specified, the encoding defaults to `UTF-8`.
-unicode_request_contents (fusion_place >= 14.1)	Specify this option when importing with a CSV encoding that includes a BOM. If a BOM for any of the following encodings is present, it is treated as that encoding. UTF-8 (0xEF 0xBB 0xBF) UTF-16 BE (0xFE 0xFF) UTF-16 LE (0xFF 0xFE) UTF-32 BE (0x00 0x00 0xFE 0xFF) UTF-32 LE (0xFF 0xFE 0x00 0x00)
-lang **	Response XML contains messages. Specify the language in which those messages should be displayed. Use `ja` for Japanese or `en` for English. For example, to specify English, use the following. + -lang en + If not specified, the language of the client operating system is used. + The language specified here is also applied to Exporting Data Using Forms.
-compression ****	Specifies whether to enable data compression during request and response transmission. To enable compression, specify `true` as follows. + -compression true + To disable compression, specify `false`. The default is `true`.
-proxy_addr ****	Specify the proxy server host name and port number connected by `:` (colon), as shown in the following example. + -proxy_addr proxy.hoge.com:3128
-socks	Specify this option if the proxy server specified with `-proxy_addr` is a SOCKS proxy. If this option is not specified, the proxy server specified with `-proxy_addr` is treated as an HTTP proxy.
-proxy_user ** -proxy_pass **	When using a proxy server that requires authentication, specify the user name with `-proxy_user` and the password with `-proxy_pass`. For example, if the user name is `user1` and the password is `pass1`, specify as follows. + -proxy_user user1 -proxy_pass pass1
-help	If `-help` is specified, processing is not executed and descriptions of each option are displayed.

-Djava.net.useSystemProxies=true
(fusion_place >= 14.1)

When a PAC file is specified in Windows proxy settings under "Automatic proxy setup > Use setup script", specifying this option allows Requester to automatically obtain the proxy server.

-encoding ****

Specifies the encoding applied to the Response File. Available values vary depending on the OS environment. Commonly used values are UTF-8 and Windows-31J (Windows extension of Shift JIS). For example, to specify Windows-31J, use the following.

+ -encoding Windows-31J

+ If not specified, the encoding defaults to UTF-8.

-unicode_request_contents
(fusion_place >= 14.1)

Specify this option when importing with a CSV encoding that includes a BOM.
If a BOM for any of the following encodings is present, it is treated as that encoding.

UTF-8 (0xEF 0xBB 0xBF)
UTF-16 BE (0xFE 0xFF)
UTF-16 LE (0xFF 0xFE)
UTF-32 BE (0x00 0x00 0xFE 0xFF)
UTF-32 LE (0xFF 0xFE 0x00 0x00)

-lang **

Response XML contains messages. Specify the language in which those messages should be displayed. Use ja for Japanese or en for English. For example, to specify English, use the following.

+ -lang en

+ If not specified, the language of the client operating system is used.

+ The language specified here is also applied to Exporting Data Using Forms.

-compression ****

Specifies whether to enable data compression during request and response transmission. To enable compression, specify true as follows.

+ -compression true

+ To disable compression, specify false. The default is true.

-proxy_addr ****

Specify the proxy server host name and port number connected by : (colon), as shown in the following example.

+ -proxy_addr proxy.hoge.com:3128

-socks

Specify this option if the proxy server specified with -proxy_addr is a SOCKS proxy. If this option is not specified, the proxy server specified with -proxy_addr is treated as an HTTP proxy.

-proxy_user ****
-proxy_pass ****

When using a proxy server that requires authentication, specify the user name with -proxy_user and the password with -proxy_pass. For example, if the user name is user1 and the password is pass1, specify as follows.

+ -proxy_user user1 -proxy_pass pass1

-help

If -help is specified, processing is not executed and descriptions of each option are displayed.

Notes on Proxy Option Settings Using Windows Proxy Configuration (Requester >= 14.1)

Proxies configured in Windows under "Manual proxy setup" are not used.

When using Requester via a proxy, explicitly specify the proxy using one of the following methods.

Specify the proxy using the -proxy_addr option
Regardless of Windows proxy settings ^[2], the specified proxy address is used.
Specify the -Djava.net.useSystemProxies=true option
Connects using the proxy address evaluated by the PAC file specified under "Automatic proxy setup > Use setup script" in Windows proxy settings.
If neither the -proxy_addr option nor the -Djava.net.useSystemProxies=true option is specified, a direct connection is used.

Requester Exit Codes

When Requester terminates, an "Exit Code" is set. The Exit Code is stored in the special variable %ERRORLEVEL%, which can be referenced to alter subsequent processing. The Exit Codes for Requester are as follows.

Exit Code	Meaning
0	Normal termination.
1	Completed with warnings. Among one or more requests included in the Request File, at least one processing result code was `WARNED`. The remaining requests have a processing result code of `SUCCESSFUL`.
2	Completed with errors. Among one or more requests included in the Request File, at least one processing result code was `ERROR`. The remaining requests have a processing result code of `SUCCESSFUL` or `WARNED`.
4	Completed with failures. Among one or more requests included in the Request File, at least one processing result code was `FAILED`.
8	Processing not possible. Processing could not be executed normally due to reasons such as incorrect command options or the server not running.

Requester and Java Runtime Environment

Executing Requester requires a Java Runtime Environment. You may install Java on the computer where Requester is used. Alternatively, on a computer where the fusion_place Runtime Environment (FRE) is installed, you can use the Java Runtime Environment included with FRE. In this case, specify the path to java.exe as follows.

(fusion_place < 12.0 )

%LocalAppData%\Programs\fusion_place\fusion_place runtime environment (NN-bit)\jreNN\bin\java.exe

(fusion_place >= 12.0 )

%LocalAppData%\fusion_place\fusion_place runtime environment (NN-bit)\runtime\bin\java.exe

NN: Replace with the FRE bitness (64 or 32). Note that there are 2 replacement locations.
%LocalAppData%: When executed from the Windows command line, replace with the appropriate folder name.

Note that FRE is installed per Windows user. Therefore, when using the Java Runtime Environment included with the fusion_place Runtime Environment as described above, you must be logged in to Windows as the user who installed FRE.

1. This refers to a computer that can connect to the fusion_place server using fusion_place [Manager], [Contributor], [Browser], or [Excel-Link].

2. Network and Internet > Proxy