fusion_place-requester-n.n.jar
リクエスタとは
リクエスタとは、大量データの一括処理や定期処理を、コマンドラインから実行するツールです。リクエスタでは、以下の処理が可能です。
リクエスタのプログラムファイル
リクエスタのプログラムファイルは、fusion_place インストーラを収めた zip ファイルに同梱されています。ファイル名は以下の通りです
|
リクエスタの実行環境
fusion_place のサーバ上でなくとも、fusion_place サーバに URL でアクセスできるコンピュータ上[1] であれば、リクエスタを実行することができます。
リクエスタは、[Web-API] を用いて fusion_place サーバと通信します。そして、[Web-API] は fusion_place 使用権許諾契約書で定義される「クライアントプログラム」のひとつです。従って、リクエスタや、[Web-API] を用いる他のプログラムを同時に稼働する場合、それらのプログラムは、それぞれ、異なるユーザアカウントを用いる必要があります。 |
リクエスタの実行方法
リクエスタは、「リクエストファイル」を読み込んで、fusion_place サーバに処理を依頼し、処理結果を「レスポンスファイル」に書き出します。リクエストファイルとレスポンスファイルは、どちらも XML 形式のテキストファイルです。リクエスタを実行するには、コマンドプロンプトで、例えば以下のように入力します。
java -Xms256m -Xmx1024m -jar fusion_place-requester-n.n..jar -url http://:***/fusionplace -user **** -pass **** -external false < request.xml > response.xml
上記コマンドラインでの指定内容を以下にご説明します。
指定内容 | 説明 | ||
---|---|---|---|
java |
|
||
-Xms256m -Xmx1024m |
プログラムの実行に使用するメモリ量を指定します。 |
||
-jar fusion_place-requester-n.n..jar |
|
||
-url http://*****:****/fusionplace |
|
||
-user **** -pass **** |
-user admin -pass jugemu |
||
-external false |
エクスターナルモード で実行する場合には、 |
||
< request.xml |
|
||
> response.xml |
|
上記以外に、以下のオプションを指定することができます。-jar ******
の後、 リクエスト・レスポンスの指定の前に指定して下さい。
指定内容 | 説明 |
---|---|
-encoding **** |
レスポンスファイルに適用するエンコーディングを指定します。指定可能な値は、OS 環境等によって異なりますが、主に使用されるのは -encoding Windows-31J 指定が無ければ、エンコーディングは |
-lang ** |
レスポンス XML にはメッセージが含まれますが、そのメッセージをどの言語で表示してほしいかを指定します。日本語の場合は -lang en 指定が無ければ、サーバのオペレーティングシステムの言語が用いられます。 ここで指定した言語は、フォームを用いたデータのエクスポートにも適用されます。 |
-compression **** |
リクエスト/レスポンスの送受信時、データ圧縮を行うことを指定します。データ圧縮を行う場合、以下のように -compression true データ圧縮を行わない場合、 |
-proxy_addr **** |
プロキシサーバのホスト名とポート番号を、以下の例のように -proxy_addr proxy.hoge.com:3128 指定がなければ、リクエスタは Windows コントロールパネルの「インターネットオプション」の「接続」に含まれるプロキシサーバ設定を用いて接続しようと試みます。 |
-socks |
|
-proxy_user **** |
認証を必要とするプロキシサーバを用いる場合、 -proxy_user user1 -proxy_pass pass1 |
-help |
|
リクエスタの終了コード
リクエスタの終了時には、「終了コード」が設定されます。終了コードは、%ERRORLEVEL%
という特殊な変数にセットされ、これを参照することによって後続処理を変更することが可能です。リクエスタの終了コードは以下の通りです。
終了コード | 意味 |
---|---|
0 |
正常終了。 |
1 |
警告あり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが |
2 |
エラーあり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが |
4 |
失敗あり。リクエストファイルに含まれるひとつまたは複数のリクエストのうち、少なくともひとつの処理において、処理結果コードが |
8 |
処理不可。コマンドオプション誤り、サーバが起動していない等の理由により、処理自体を正常に実行できませんでした。 |
リクエスタと Java 実行環境
リクエスタの実行には、Java 実行環境が必要です。リクエスタを使用するコンピュータに Java をインストールしても構いませんが、fusion_place 実行環境(FRE)をインストール済のコンピュータでは、FRE に含まれている Java 実行環境を使用することも可能です。この場合、java.exe
のパスを以下のように指定して下さい。
(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
-
FRE のビット数(
64
または32
)で置換ください(置換箇所が2
点ありますのでご注意ください) - %LocalAppData%
-
Windows のコマンドラインから実行する際に、適切なフォルダ名で置換されます。
なお、FRE は、Windows ユーザごとにインストールされますので、上記のようにして fusion_place 実行環境に含まれる Java を使用する場合には、FRE をインストールした Windows ユーザで、Windows にログインしておく必要があります。