フォルダ監視サービス

フォルダ監視サービスは、特定のフォルダにコピーされた文書を自動的に検出し、Web Interface V5.0 を利用して変換結果を指定されたフォルダへ出力するクライアント側のWindowsサービスです。

Folder Monitoring Overview

サービスを実行するには Web Interface V5.0 のウェブサーバが動作している必要があります。つまり、クライアント側からウェブサーバに対してリクエストを送ることができる状態が整っていなければなりません。

フォルダ監視サービスを開始すると、次の一連の処理が一定の間隔で繰り返し行われます。

  1. 監視対象のフォルダにファイルが存在するかどうか確認します。
  2. ファイルが存在する場合、ファイル内容(変換対象ファイルと変換指示ファイル)から XdsCmd_V50用のコマンドファイルを生成します。
  3. XdsCmd_V50 を実行して Web Interface V5.0 ウェブサーバにリクエストを送信します。
  4. Web Interface V5.0 ウェブサーバから返ってきた結果を出力フォルダに格納します。

フォルダ監視サービスを実行するには、最初に設定ツール(XfmAdminTool.exe)を使って送信先ホストや監視対象フォルダ、出力先フォルダといった情報を適切に設定しておく必要があります。 この設定は、一度行っておけば変更がない限り再設定する必要はありません。

XfmAdminTool

[Install directory]/bin/XfmAdminTool.exe を起動するとフォルダ監視サービスのための設定を行うことができます。 この設定内容は、XfmAdminTool.exe と同じディレクトリに monitor-config.dat という名前で保存されています。

注意: Windows Vista 以降では、管理者として実行してください。

XfmAdminTool

監視フォルダ設定ダイアログ

監視フォルダ設定ダイアログでは、監視フォルダに関する詳細設定を行います。

AdminTool2

  • 監視フォルダ(M)

    監視対象のフォルダを指定します。 右端の [...] ボタンを押すとフォルダ選択画面が表示されます。 何かファイルの含まれるディレクトリを新たに指定することはできません。

  • 出力フォルダ(O)

    変換結果が出力されるフォルダを指定します。 右端の [...] ボタンを押すとフォルダ選択画面が表示されます。

  • 出力形式(T)

    PDFとSVGどちらかの出力形式を選択します。

  • ソフトウェア種別(K)

    AH Formatter のバージョンを指定します。

  • 通知先メールアドレス(E)

    変換結果をメールで通知して欲しいときに送信先メールアドレスを指定します。 一つのメールアドレスごとに改行して入力することで、複数のメールアドレスを指定することができます。

サービスの開始

フォルダ監視サービスのWindowsサービス名は「Folder Monitoring Service」です。 サービスを開始するには、Windowsのサービスマネージャを起動し、表示されるサービス一覧から「Folder Monitoring Service」を選択して開始を指示する必要があります。 サービスマネージャは、コントロールパネルから [管理ツール]-[サービス] を選んでください。

Services

利用方法

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

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

このアーカイブは、通常、これらの変換に必要なファイルをまとめてZIP圧縮して作成します。 このとき、変換対象文書が参照するローカルな画像などはディレクトリの位置関係を維持したままアーカイブされなければなりません。 例えば、アーカイブは次のような内容です。

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

必要なファイルが変換対象文書1ファイルのみの場合、例えば、変換対象文書がFOで変換指示ファイルが不要なケースでは、ZIP圧縮せず変換対象文書そのものを直接監視フォルダに置いてもかまいません。

変換指示ファイル

変換指示ファイルは変換方法を指定するためのファイルで、ファイル名は command.txt固定です。 変換指示ファイルは変換対象アーカイブのルート位置にのみ配置することができます。

変換指示ファイルの設定内容は、監視フォルダ設定ダイアログで設定されている内容をデフォルトとして評価されます。 つまり、キーを含めて省略された項目に対しては監視フォルダ設定ダイアログに対応項目があれば、その設定が採用されます。 キーだけ指定して値を省略した項目に対しては監視フォルダ設定ダイアログの対応項目は無視されます。 例えば、EMAIL= という行そのものが存在しないときは監視フォルダ設定ダイアログで指定されている通知先メールアドレスがすべて採用されます。EMAIL= とだけ記述されている場合は監視フォルダ設定ダイアログの設定は無視されて、どこにもメールが通知されません。

すべて監視フォルダ設定ダイアログの設定に従うのなら、変換指示ファイルを用意する必要はありません。

変換指示ファイルの内容は、各行が key = value という形式で各変換指示の内容を指定します。 指定方法は下記の書式となります。

DOCUMENT=filename
STYLESHEET=filename
XSLT_PARAM=[key=value[,key=value...]]
OUTPUT_TYPE=pdf|svg
OUTPUT_OPTION=[key=value[,key=value...]]
OUTPUT=filename
SOFTWARE_TYPE=fo6
FORMATTER_TYPE=auto|html|xhtml|xmlcss|xslfo
EMAIL=[mailaddress[,mailaddress...]]
EXITLEVEL=1|2|3|4

各変換指示情報に関しての詳細内容を次に示します。

キー 説明 省略時の動作
DOCUMENT 変換対象ファイル名を指定します。ファイル名は変換指示ファイルからの相対パスで指定します。 変換対象アーカイブに含まれるファイルのうち、変換指示ファイルやスタイルシート以外の最初に見つかったファイルを変換対象ファイルとみなします。
STYLESHEET スタイルシートファイル名を指定します。ファイル名は変換指示ファイルからの相対パスで指定します(CSSファイルは、ここでは指定しないでください)。 変換対象アーカイブに含まれるファイルの中に .xsl の拡張子を持つファイルがあればそれをスタイルシートとみなします。
OUTPUT 出力ファイル名を指定します。 ファイル名にディレクトリ指定を含めることはできません。 ファイル名は、変換対象アーカイブのファイル名になります。 拡張子はOUTPUT_TYPEで指定された出力形式と同じになります。例えば、変換対象アーカイブが Document.zip で、OUTPUT_TYPE=pdf ならば、Document.pdf となります。
OUTPUT_TYPE 出力形式を指定します。 監視フォルダ設定ダイアログ出力形式で設定されている内容とみなされます。
OUTPUT_OPTION 出力形式に関するオプションを指定します。 カンマで区切ることで複数指定できます。 指定できるオプションは、描画オプションと同じです。 既定値で出力を行います。
XSLT_PARAM XSLT変換時のパラメータ xsl:param を指定します。 カンマで区切ることで複数指定できます。 既定値で変換を行います。
SOFTWARE_TYPE 変換に使用する AH Formatter の種類を指定します。組み合わせには AH Formatter V6 を使用するため"fo6"を指定してください。 監視フォルダ設定ダイアログソフトウェア種別で設定されている内容とみなされます。
FORMATTER_TYPE 組版種別を指定します。 組版種別に 'auto'(自動判定)が指定されたものとみなされます。
EMAIL 変換結果を送信するメールアドレスを指定します。 カンマで区切ることで複数指定できます。 監視フォルダ設定ダイアログ通知先メールアドレスで設定されている内容とみなされます。
EXITLEVEL 組版でエラーが発生した場合の処理の中止条件を指定します。値は 1~4 で指定してください。
  1. 情報
  2. 警告
  3. 回復可能エラー
  4. 致命的エラー
エラーレベル≧ここで指定した EXITLEVEL の場合、組版を中止します。
既定値の 4 で出力を行います。
  • キーの大文字小文字は区別されます。
  • 区切り文字( = および , )前後の空白は無視されます。
  • 値に空白やカンマなどを含めたいときは "..." で囲んでください。このとき、" 自身は "" と表現します。

次は、AH Formatter V6 を使用してtest.xmltest.xsl というスタイルシートを適用し、PDFに変換して結果をoutput.pdf として作成して、結果を test@antenna.co.jp にメールで通知する変換指示ファイルの例です。

DOCUMENT=test.xml
STYLESHEET=test.xsl
OUTPUT_TYPE=pdf
OUTPUT=output.pdf
SOFTWARE_TYPE=fo6
EMAIL=test@antenna.co.jp

次は、AH Formatter V6 を使用してtest.htmltest.css というスタイルシートを適用し、PDFに変換して結果をoutput.pdf として作成する変換指示ファイルの例です。スタイルシートにCSSファイルを使用する場合は、"STYLESHEET="行を追加してください。

DOCUMENT=test.html
STYLESHEET=
OUTPUT_TYPE=pdf
OUTPUT=output.pdf
SOFTWARE_TYPE=fo6

変換結果

フォルダ監視サービスが監視フォルダに置かれたファイルを検知すると、その監視フォルダの下に backup というフォルダを作って検知したファイルを退避します。 そして、ウェブサービスに変換を依頼します。 変換が正常に終了すると、監視フォルダ設定ダイアログで指定された出力フォルダに変換されたファイルが置かれます。

監視フォルダ設定ダイアログで [通知先メールアドレス] が設定されている場合は、メールで変換が正常に終了したかどうかが報告されます。

そのような通知を指定していない場合は、ご自身で出力先フォルダに結果が置かれたかどうかを確認しなければなりません。 変換に関する情報はログファイルに出力されるので、変換が成功したかどうかなどはそれを確認してください。

backupフォルダには、backup/20130930203046/2/archive.zip のように、変換日時のサブフォルダとさらにその下に同一変換日時に受け付けたファイルを区別するために連番のサブフォルダが作られて、監視フォルダに置かれたファイルが退避されます。このファイルは、不要ならばいつでも削除してかまいません。

ロギング

フォルダ監視サービスのログは [Install directory]/logs フォルダに xfmservice-YYYY-MM-DD.log というファイル名で格納されます。YYYY-MM-DD は日付を表わし、ファイルは日ごとに作成されます。 エラー情報も出力されるので、何か変換エラーが起こった場合はこのログファイルを参照してエラー内容を確認してください。 また、何らかの理由によりログが出力できない場合はイベントログにエラーが出力されます。


Copyright © 2005-2016 Antenna House, Inc. All rights reserved.
Antenna House is a trademark of Antenna House, Inc.