Watched Folder サービスの設定

Watched Folder サービス(WatchedFolder)では、すべての監視フォルダーエンドポイントに共通する属性を設定します。また、監視フォルダーエンドポイントのデフォルト値も指定します(監視フォルダーエンドポイントの設定を参照)。このサービスは、外部クライアントアプリケーションによって呼び出されることも、Workbench で作成されたプロセスで使用されることもありません。

Watched Folder サービスでは、以下の設定を使用できます。

Cron Expression:
Cron 形式は、入力ディレクトリのポーリングをスケジュールするために Quartz で使用されます。

Repeat Count:
入力ディレクトリのポーリング回数です。エンドポイントの設定でこの値を指定しない場合は、デフォルトの繰り返し回数が使用されます。「-1」の値を指定すると、ディレクトリは無限にスキャンされます。デフォルト値は「-1」です。

Repeat Interval:
ポーリング間のデフォルトの秒数です。監視フォルダーエンドポイント設定にデフォルト値が指定されていない場合、繰り返し間隔としてこの値が使用されます。デフォルト値は 5 です。詳しくは、「バッチサイズ」設定の説明を参照してください。

Asynchronous:
呼び出しを非同期型にするか同期型にするかを指定します。一過性および同期型のプロセスは、同期型でのみ呼び出すことができます。デフォルト値は「asynchronous」です。

Wait Time:
ファイルを入力フォルダーから取得した後で待機するデフォルトの時間(秒単位)です。待機時間に指定されている時間より古いファイルまたはフォルダーが、処理対象として取得されます。デフォルト値は 0 です。

Batch Size:
1 回のスキャンで処理されるデフォルトのファイル数またはフォルダー数です。デフォルト値は 2 です。

「繰り返し間隔 」設定と「バッチサイズ 」設定では、監視フォルダーがスキャンごとにファイルをいくつ取得するかを指定します。監視フォルダーは、Quartz スレッドプールを使用して入力フォルダーをスキャンします。スレッドプールは他のサービスと共有されます。スキャンの間隔が小さいと、スレッドによって入力フォルダーが頻繁にスキャンされます。ファイルが頻繁に監視フォルダーに配置される場合は、スキャンの間隔を小さくします。ファイルが頻繁には配置されない場合は、他のサービスがスレッドを使用できるように、スキャンの間隔を大きくします。

配置されるファイル数が多い場合は、バッチサイズを大きくします。例えば、監視フォルダーエンドポイントによって呼び出されるサービスが 1 分間に 700 個のファイルを処理でき、これと同じ速度でユーザーが入力フォルダーにファイルを配置するとします。このとき、「バッチサイズ 」を 350 に、「繰り返し間隔 」を 30 秒に設定すると、過度に頻繁に監視フォルダーをスキャンするコストを発生させることなく、監視フォルダーのパフォーマンス向上につなげることができます。

ファイルが監視フォルダーに配置されると監視フォルダーはファイルを入力内に一覧化するので、スキャンが毎秒行われているとパフォーマンスが低下する可能性があります。スキャンの間隔を大きくすると、パフォーマンスが向上する可能性があります。配置されるファイルの量が少ない場合は、それに従って「バッチサイズ 」と「繰り返し間隔 」を調整します。例えば、毎秒 10 個のファイルが配置される場合は、「繰り返し間隔 」を 1 秒に、「バッチサイズ 」を 10 に設定します。

クラスターの設定では、監視フォルダーエンドポイントのバッチサイズが複数のクラスターノードに対して調整されません。例えば、2 ノードクラスターに対してバッチサイズが 2 に設定され、「ジョブ数を制限」オプションが選択されている場合、各ノードで 2 つのファイルが同時に処理されるのではなく、両方のノードでまとめて 2 つのバッチによりファイルが処理されます。

Overwrite Duplicate Filenames:
監視フォルダーで結果ファイルが同じ名前の既存のファイルを上書きするかどうか、および保持されていた同じ名前のドキュメントを上書きするかどうかを指定する Boolean 文字列です。

Preserve Folder:
保持用フォルダーのデフォルト値です。このフォルダーは、入力が正常に処理された場合にソースファイルをコピーするために使用されます。何も指定しないか、結果フォルダー設定で説明されているファイルパターンを使用して相対パスまたは絶対パスを指定できます。

Failure Folder:
失敗ファイルがコピーされるフォルダーの名前です。何も指定しないか、結果フォルダー設定で説明されているファイルパターンを使用して相対パスまたは絶対パスを指定できます。

Result Folder:
結果フォルダーのデフォルト名です。このフォルダーに結果ファイルがコピーされます。何も指定しないか、相対パスまたは絶対パスを次のファイルパターンを使用して指定できます。
  • %F = ファイル名プレフィックス

  • %E = ファイル拡張子

  • %Y = 年(4 桁表記)

  • %y = 年(下 2 桁)

  • %M = 月

  • %D = 日(1~31)

  • %d = 日(通日)

  • %H = 時(24 時間)

  • %h = 時(12 時間)

  • %m = 分

  • %s = 秒

  • %l = ミリ秒

  • %R = 乱数(0~9)

  • %P = プロセス ID またはジョブ ID

例えば、2009 年 7 月 17 日午後 8 時で、C:/Test/WF0/failure/%Y/%M/%D/%H/ と指定した場合、結果のフォルダーは C:/Test/WF0/failure/2009/07/17/20 です。

絶対パスではなく相対パスを指定すると、監視フォルダーの中に作成されます。ファイルパターンについて詳しくは、ファイルパターンについてを参照してください。

注意: 結果フォルダーのサイズを小さくすればするほど、監視フォルダーのパフォーマンスが向上します。例えば、監視フォルダーの推定負荷が 1 時間に 1000 個のファイルである場合、1 時間ごとに新しいサブフォルダーが作成されるように result/%Y%M%D%H のようなパターンを使用します。これよりも負荷が小さい場合(例えば、1 日に 1000 個のファイル)、result/%Y%M%D のようなパターンを使用することもできます。

Stage Folder:
監視フォルダー内に作成されるステージフォルダーのデフォルト名です。

Input Folder:
監視フォルダーに作成される入力フォルダーのデフォルト名です。

Preserve On Failure:
true を指定すると、失敗時に元のファイルが失敗フォルダーに保存されます。

Throttle:
このオプションを選択すると、LiveCycle で同時に処理できる監視フォルダーのジョブ数が制限されます。「バッチサイズ」の値によって、ジョブの最大数が決まります(ジョブ数の制限についてを参照)。