リクエスタとは

« Excel-Link | リクエストファイルの形式 »

リクエスタとは、大量データの一括処理や定期処理を、コマンドラインから実行するツールです。リクエスタでは、以下の処理が可能です。

リクエスタのプログラムファイル

リクエスタのプログラムファイルは、fusion_place インストーラを収めた zip ファイルに同梱されています。ファイル名は以下の通りです。

fusion_place-requester-n.n.jar n.n の箇所はバージョン番号です

※ 拡張子 jar は、このファイルが、Java プログラムを収めていることを意味します。

リクエスタの実行環境

fusion_place のサーバ上でなくとも、fusion_place サーバに URL でアクセスできるコンピュータ上（※）であれば、リクエスタを実行することができます。

※ fusion_place [マネージャ]/[コントリビュータ]/[ブラウザ] や [Excel-Link] を用いて fusion_place サーバに接続できるコンピュータのことです。

なお、リクエスタは、[Web API] を用いて fusion_place サーバと通信します。そして、[Web API] は fusion_place 使用権許諾契約書で定義される「クライアントプログラム」のひとつです。従って、リクエスタや、[Web API] を用いる他のプログラムを同時に稼働する場合、それらのプログラムは、それぞれ、異なるユーザアカウントを用いる必要があります。

リクエスタの実行方法

リクエスタは、「リクエストファイル」を読み込んで、fusion_place サーバに処理を依頼し、処理結果を「レスポンスファイル」に書き出します。リクエストファイルとレスポンスファイルは、どちらも XML 形式のテキストファイルです。リクエスタを実行するには、コマンドプロンプトで、例えば以下のように入力します。下記では行を分けて書いていますが、実際には一行に入力して下さい。

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

上記コマンドラインでの指定内容を以下にご説明します。

指定内容	説明
java	java.exe プログラムの実行を指示します。java.exe のパスが PATH 変数に指定されていない場合、フォルダも含めて指定して下さい。
-Xms256m -Xmx1024m	プログラムの実行に使用するメモリ量を指定します。-Xms は初期メモリ量、-Xmx は最大メモリ量です。値の末尾の m はメガバイトを意味します。先の例では初期メモリ量が 256 メガバイト、最大メモリ量が 1024 メガバイト（1 ギガバイト）となります。
-jar fusion_place-requester-n.n..jar	-jar に続けて、実行するリクエスタのファイル名 fusionplace-requester-n.n..jar を指定します。n.n はバージョン番号で置き換えて下さい。
-url http://***:**/fusionplace	-url に続けて、fusion_place のサーバの URL を指定して下さい。これは、リクエスタを実行しようとしているコンピュータから、[Excel-Link] 等を用いて fusion_place サーバにアクセスする際に接続先として設定する URL と同じです。
-user ** -pass **	-user には、fusion_place のユーザアカウント名、-pass にはパスワードを指定して下さい。ユーザアカウント名が admin で、パスワードが jugemu でしたら、以下のようになります。 -user admin -pass jugemu
- external false	エクスターナルモードで実行する場合には、「-external true」、通常モードで実行する場合には、「-external false」と指定ます。いずれも指定しなかった場合には、通常モードで実行されます。
< request.xml	< に続けて、リクエストファイルのファイル名を指定して下さい。左記ではファイル名が request.xml となっていますが、異なる名前でも構いません。ファイルがカレントフォルダ以外にある場合にはパスを含めて指定して下さい。 ※ リクエスタは、リクエストを標準入力から読み込みます。
> response.xml	> に続けて、レスポンスファイルのファイル名を指定して下さい。左記ではファイル名が response.xml となっていますが、異なる名前でも構いません。ファイルをカレントフォルダ以外に作成したい場合にはパスを含めて指定して下さい。 ※ リクエスタはレスポンスを標準出力に書き込みます。なお、リクエスタが処理中に表示するメッセージは標準エラー出力に書き出されます。

指定内容

説明

java

java.exe プログラムの実行を指示します。java.exe のパスが PATH 変数に指定されていない場合、フォルダも含めて指定して下さい。

-Xms256m -Xmx1024m

プログラムの実行に使用するメモリ量を指定します。-Xms は初期メモリ量、-Xmx は最大メモリ量です。値の末尾の m はメガバイトを意味します。先の例では初期メモリ量が 256 メガバイト、最大メモリ量が 1024 メガバイト（1 ギガバイト）となります。

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

-jar に続けて、実行するリクエスタのファイル名 fusionplace-requester-n.n..jar を指定します。n.n はバージョン番号で置き換えて下さい。

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

-url に続けて、fusion_place のサーバの URL を指定して下さい。これは、リクエスタを実行しようとしているコンピュータから、[Excel-Link] 等を用いて fusion_place サーバにアクセスする際に接続先として設定する URL と同じです。

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

-user には、fusion_place のユーザアカウント名、-pass にはパスワードを指定して下さい。ユーザアカウント名が admin で、パスワードが jugemu でしたら、以下のようになります。

-user admin -pass jugemu

- external false

エクスターナルモードで実行する場合には、「-external true」、通常モードで実行する場合には、「-external false」と指定ます。いずれも指定しなかった場合には、通常モードで実行されます。

< request.xml

< に続けて、リクエストファイルのファイル名を指定して下さい。左記ではファイル名が request.xml となっていますが、異なる名前でも構いません。ファイルがカレントフォルダ以外にある場合にはパスを含めて指定して下さい。

※ リクエスタは、リクエストを標準入力から読み込みます。

> response.xml

> に続けて、レスポンスファイルのファイル名を指定して下さい。左記ではファイル名が response.xml となっていますが、異なる名前でも構いません。ファイルをカレントフォルダ以外に作成したい場合にはパスを含めて指定して下さい。

※ リクエスタはレスポンスを標準出力に書き込みます。なお、リクエスタが処理中に表示するメッセージは標準エラー出力に書き出されます。

上記以外に、以下のオプションを指定することができます。 -jar ****** の後、リクエスト・レスポンスの指定の前に指定して下さい。

指定内容	説明
-encoding ****	レスポンスファイルに適用するエンコーディングを指定します。指定可能な値は、OS 環境等によって異なりますが、主に使用されるのは UTF-8 と Windows-31J（シフト JIS の Windows 拡張）です。例えば、Windows-31J を指定する場合、以下のようにして下さい： -encoding Windows-31J 指定が無ければ、エンコーディングは、UTF-8 となります。
-lang **	レスポンス XML にはメッセージが含まれますが、そのメッセージをどの言語で表示してほしいかを指定します。日本語の場合は ja、英語の場合は en です。例えば、英語と指定する場合、以下のようにして下さい： -lang en 指定が無ければ、サーバのオペレーティングシステムの言語が用いられます。ここで指定した言語は、「フォームを用いたデータのエキスポート」にも適用されます。
-compression ****	リクエスト／レスポンスの送受信時、データ圧縮を行うことを指定します。データ圧縮を行う場合、以下のように true と指定します： -compression true データ圧縮を行わない場合、false を指定します。デフォルトは true です。
-proxy_addr ****	プロキシサーバのホスト名とポート番号を、「：」（コロン）でつないで指定して下さい：例） -proxy_addr proxy.hoge.com:3128 指定がなければ、リクエスタは Windows コントロールパネルの「インターネットオプション」の「接続」に含まれるプロキシサーバ設定を用いて接続しようと試みます。
-socks	-proxy_addr で指定したプロキシサーバが、SOCKS プロキシである場合、当オプションを指定して下さい。当オプションが指定されていなければ、-proxy_addr で指定したプロキシサーバは HTTP プロキシとみなされます。
-proxy_user ** -proxy_pass **	認証を必要とするプロキシサーバを用いる場合、-proxy_user にユーザ名を指定し、 -proxy_pass にパスワードを指定してください。ユーザ名が user1、パスワードが pass1 でしたら、以下のようになります： -proxy_user user1 -proxy_pass pass1
-help	-help を指定すると、処理は実行されずに、各オプションに関する説明が表示されます。

指定内容

説明

-encoding ****

レスポンスファイルに適用するエンコーディングを指定します。指定可能な値は、OS 環境等によって異なりますが、主に使用されるのは UTF-8 と Windows-31J（シフト JIS の Windows 拡張）です。
例えば、Windows-31J を指定する場合、以下のようにして下さい：

-encoding Windows-31J

指定が無ければ、エンコーディングは、UTF-8 となります。

-lang **

レスポンス XML にはメッセージが含まれますが、そのメッセージをどの言語で表示してほしいかを指定します。日本語の場合は ja、英語の場合は en です。
例えば、英語と指定する場合、以下のようにして下さい：

-lang en

指定が無ければ、サーバのオペレーティングシステムの言語が用いられます。

ここで指定した言語は、「フォームを用いたデータのエキスポート」にも適用されます。

-compression ****

リクエスト／レスポンスの送受信時、データ圧縮を行うことを指定します。

データ圧縮を行う場合、以下のように true と指定します：

-compression true

データ圧縮を行わない場合、false を指定します。デフォルトは true です。

-proxy_addr ****

プロキシサーバのホスト名とポート番号を、「：」（コロン）でつないで指定して下さい：

例） -proxy_addr proxy.hoge.com:3128

指定がなければ、リクエスタは Windows コントロールパネルの「インターネットオプション」の「接続」に含まれるプロキシサーバ設定を用いて接続しようと試みます。

-socks

-proxy_addr で指定したプロキシサーバが、SOCKS プロキシである場合、当オプションを指定して下さい。当オプションが指定されていなければ、-proxy_addr で指定したプロキシサーバは HTTP プロキシとみなされます。

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

認証を必要とするプロキシサーバを用いる場合、-proxy_user にユーザ名を指定し、
-proxy_pass にパスワードを指定してください。ユーザ名が user1、パスワードが pass1 でしたら、以下のようになります：

-proxy_user user1 -proxy_pass pass1

-help

-help を指定すると、処理は実行されずに、各オプションに関する説明が表示されます。

リクエスタの終了コード

リクエスタの終了時には、「終了コード」が設定されます。終了コードは、「%ERRORLEVEL%」という特殊な変数にセットされ、これを参照することによって後続処理を変更することが可能です。リクエスタの終了コードは以下の通りです。

終了コード	意味
0	正常終了。
1	警告あり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが「WARNED」となりました。残りのリクエストについては処理結果コードは「SUCCESSFUL」です。
2	エラーあり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが「ERROR」となりました。残りのリクエストについては処理結果コードは「SUCCESSFUL」または「WARNED」です。
4	失敗あり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが「FAILED」となりました。
8	処理不可。コマンドオプション誤り、サーバが起動していない等の理由により、処理自体を正常に実行できませんでした。

リクエスタと Java 実行環境

リクエスタの実行には、Java 実行環境が必要です。リクエスタを使用する PC に Java をインストールしても構いませんが、fusion_place 実行環境をインストール済の PC では、同実行環境に含まれている Java 実行環境を使用することも可能です。この場合、java.exe のパスを以下のように指定して下さい：

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

NN ・・・ fusion_place 実行環境のビット数（64 または 32）で置換ください（置換箇所が二か所ありますのでご注意ください）

%LocalAppData% ・・・ Windows のコマンドラインから実行する際に、適切なフォルダ名で置換されます。

なお、fusion_place 実行環境は、Windows ユーザごとにインストールされますので、上記のようにして fusion_place 実行環境に含まれる Java を使用する場合には、fusion_place 実行環境をインストールした Windows ユーザで、Windows にログインしておく必要があります。