フォルダ監視サービス

フォルダ監視サービスはクライアント側のプログラムで、指定したフォルダにコピーされた文書を自動的に感知し、変換結果を Web Interface V6.0 を利用して指定されたフォルダに出力します。

このサービスを使ってリクエストを処理するためには、Web Interface V6.0 のサーバプログラムが動作している必要があります。

フォルダ監視サービスが開始すると、監視フォルダ内のファイルの処理を行います。開始後でも、フォルダ内に新しくコピーされたファイルの処理も行います。サービスはそれぞれのファイルに対して、次のような処理を行います。

1. ファイルの内容（変換対象のファイルと、変換内容を指示しているファイル）から Web Interface V6.0 のクライアントプログラムのコマンドラインを生成します。
2. リクエストを Web Interface V6.0 のサーバプログラムに送信します。
3. Web Interface V6.0 のサーバプログラムから返ってきた結果を出力フォルダに格納します。

サーバアドレスのようなネットワークオプションはフォルダ監視サービスで使うデフォルトのコマンドファイルとして指定しておくことができます。または、監視されるフォルダ内にコピーする ZIP ファイル内のコマンドファイルで指示することができます。

Web Interface V6.0 のフォルダ監視サービスの JAR ファイルは xds-folder-monitor.jar です。

監視するフォルダと出力先フォルダの位置をコマンドラインで次のように指定します。

java -jar xds-folder-monitor.jar [options] <first directory to watch> <first directory output> <second directory to watch> <second directory output> ...
  

java -jar xds-folder-monitor.jar C:\folder1 C:\folder1\output
  

出力先フォルダは監視フォルダのサブディレクトリでなければなりません。

環境変数 XDS_FOLDER_MONITOR_CONFIG を利用して、動作上の既定値とするコマンドラインオプションを記述したxmlファイルを絶対パスで指定することができます。ファイルの記述についてはオプションファイルを参照してください。

フォルダ監視サービスを利用するには変換対象ファイルをZIPアーカイブし、ひとつのファイルとして監視フォルダに置きます。 フォルダ監視サービスが自動的にファイルを見つけて処理し、変換結果を出力フォルダへ置きます。

変換対象ファイルのアーカイブには次のファイルを含めることができます。

• 変換対象文書（xml、xsl、fo、html、xhtml など）
• コマンドファイル（command.txt）
• 外部参照ファイル（画像ファイル等）

変換するファイルはすべてを一つのZIPファイルに圧縮する必要があります。入力文書から参照するメディアファイルはZIPファイル内で同じフォルダ構成を保つ必要があります。例えば、圧縮ファイルが次の内容を含むとします。

.-+- command.txt
  +- document.xml
  +- style.xsl
  +- images/
      +- pic01.png
      +- pic02.png

ZIP圧縮ファイルに加えて、単一のFOファイルのような単純な文書も監視フォルダに入れることができます。それらはフォルダ監視のデフォルトオプションを用いて変換が行われます。

コマンドファイル

ARGS=[space separated list of Client Program options]
ARGS_REMOVE=[comma separated list of Client Program options]
DOCUMENT=filename
STYLESHEET=filename
XSLT_PARAM=[key=value[,key=value...]]
OUTPUT_TYPE=[Antenna House Formatter output type:  pdf|svg|...]
OUTPUT_OPTION=[key=value[,key=value...]]
OUTPUT=filename
FORMATTER_TYPE=auto|html|xhtml|xmlcss|xslfo
EMAIL=[mailaddress[,mailaddress...]]
EXITLEVEL=1|2|3|4
SMTP_HOST=[mail server adress]
SMTP_PORT=[mail server port]
SMTP_PASSWORD=[mail server password]
SMTP_STARTTLS=[boolean value: 'true' or 'false']
SMTP_SSL=[boolean value: 'true' or 'false']
SMTP_FROM=[mailaddress]
SMTP_USER=[user login name]

  ARGS = -xds-host 10.1.10.14 -d input.fo -o output.pdf -tpdf -x 4
  EMAIL = test@antenna.co.jp

	ARGS = -xds-host 10.1.10.24
	ARGS = -d input.fo
	ARGS = -o output.pdf
	...
      

	ARGS_REMOVE = -xds-host 1
	ARGS_REMOVE = -tpdf, -lpdf, -o 1
	...
      

  ARGS=-xds-host 10.1.10.24
  ARGS=-d test.xml -s test.xsl -p @PDF -o output.pdf
  EMAIL=test@antenna.co.jp

変換結果

  backup/20240118123456/2/archive.zip

eメールの送信

EMAIL = test@antenna.co.jp
SMTP_HOST = smtp.example.com
SMTP_PORT = 25
SMTP_USER = example
SMTP_PASSWORD = password
SMTP_STARTTLS = true

Folder Monitor Results: 2024-01-18--12:00:00

Document conversion succeeded.

input file: C:\FolderMonitorTest\test.zip
output file: C:\FolderMonitorTest\output\test.pdf

Web Interface V6.0 のフォルダ監視サービスはファイルとコンソールにロギング情報を出力することが可能です。ApacheのLog4jライブラリを使って、出力先やログの出力レベルが容易に変更することが可能です。詳しくはロギングを参照してください。もしログ設定ファイルがオプションで指定されていなければ、デフォルトのロギングの振る舞いは、DEBUGレベルのメッセージを[Install directory]/logs/folder-monitor.logとコンソールの両方に出力します。

描画オプションはキーワードと値の対で表現され、描画方法を制御します。キーワードは Antenna House Formatter のコマンドラインオプション AHFCmd の一部と同一です。詳細は Antenna House Formatter のマニュアルを参照してください。

• フォルダ監視サービスのLinux版では、fuser ユーティリティをインストールし、実行環境のサーチパスを有効にしておく必要があります。
• フォルダ監視サービスは、java.nio.file.WatchService ライブラリを使用しています。Linux 版は inotify をベースにしており、CIFS のようなファイルシステムのファイル作成イベントを監視する能力を持っていません。
• Java の仮想マシンの -Dmail.debug=true オプションを使ってメールに関する事項をデバッグすることができます。

  java -Dmail.debug=true -jar xds-folder-monitor.jar ...