ドキュメントAEM 6.5ユーザーガイド

監視フォルダーのエンドポイントの設定 configuring-watched-folder-endpoints

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • ユーザー
  • 開発者

管理者は、監視フォルダー ​と呼ばれるネットワークフォルダーを設定できます。ユーザーがファイル（PDF ファイルなど）を監視フォルダーに配置すると、設定済みのサービス操作が呼び出され、ファイルが操作されます。サービスが指定の操作を実行した後に、変更されたファイルが指定の出力フォルダーに保存されます。

監視フォルダーサービスの設定 configuring-the-watched-folder-service

監視フォルダーエンドポイントを設定する前に、監視フォルダーサービスを設定します。監視フォルダーサービスの設定パラメーターには、2 つの用途があります。

  • すべての監視フォルダーエンドポイントに共通する属性を設定すること
  • すべての監視フォルダーエンドポイントで使用されるデフォルト値を指定すること

監視フォルダーサービスを設定した後、ターゲットのサービス用に監視フォルダーエンドポイントを追加します。エンドポイントを追加するときには、設定済みの監視フォルダーサービスの入力フォルダーにファイルまたはフォルダーが配置されている場合に呼び出すサービス名や操作名など、値をいくつか設定します。監視フォルダーサービスの設定について詳しくは、監視フォルダーサービスの設定を参照してください。

監視フォルダーの作成 creating-a-watched-folder

次の 2 つの方法で、監視フォルダーを作成できます。

  • 監視フォルダーエンドポイントを設定するには、親ディレクトリの「パス」ボックスにフルパスを入力し、作成する監視フォルダーの名前を付けます。例えば、次のように入力します。
      C:\MyPDFs\MyWatchedFolderMyWatchedFolder フォルダーはもともと存在していないので、AEM Forms は指定した場所にこのディレクトリを作成しようとします。

  • 監視フォルダーエンドポイントを設定する前に、ファイルシステムでフォルダーを作成し、「パス」ボックスにフルパスを入力します。

クラスター環境では、監視フォルダーとして使用されるフォルダーは、ファイルシステムまたはネットワークでアクセス可能および書き込み可能で、共有されている必要があります。この場合、クラスターの各アプリケーションサーバーインスタンスは同じ共有フォルダーにアクセスできる必要があります。

Windows でアプリケーションサーバーがサービスとして実行されている場合、アプリケーションサーバーは、次のいずれかの方法で共有フォルダーへの適切なアクセス権が設定された状態で起動されている必要があります。

  • アプリケーションサーバーサービスの「ログオン」パラメーター ​を設定し、共有監視フォルダーへの適切なアクセス権を持つ特定のユーザーとして起動します。
  • アプリケーションサーバーサービスの「ローカルシステムアカウント」オプションで「デスクトップとの対話をサービスに許可」を設定します。このオプションを使用する場合、共有監視フォルダーがすべてのユーザーによりアクセス可能および書き込み可能である必要があります。

監視フォルダーの連結 chaining-together-watched-folders

複数の監視フォルダーを連結して、ある監視フォルダーの結果ドキュメントを次の監視フォルダーの入力ドキュメントにすることができます。監視フォルダーごとに、別々のサービスを呼び出すことができます。この方法で監視フォルダーを設定すると、複数のサービスを呼び出すことができます。例えば、1 つの監視フォルダーでは PDF ファイルを Adobe PostScript® に変換し、別の監視フォルダーでは PostScript ファイルを PDF/A 形式に変換することができます。そのためには、最初のエンドポイントで定義されている監視フォルダーの​ 結果 ​フォルダーを、次のエンドポイントで定義されている監視フォルダーの​ 入力 ​フォルダーに設定します。

そうすると、最初の変換処理からの出力は、\path\result に送られます。2 回目の変換処理に対する入力は \path\result になり、2 回目の変換処理からの出力は \path\result\result（または 2 回目の変換処理用に「結果フォルダー」ボックスで定義したディレクトリ）に送られます。

ユーザーによる監視フォルダーの操作方法 how-users-interact-with-watched-folders

監視フォルダーエンドポイントが 1 つの場合、ユーザーは入力ファイルまたはフォルダーをデスクトップから監視フォルダーにコピーまたはドラッグすることによって、サービス操作を呼び出すことができます。ファイルは、到着した順序で処理されます。

監視フォルダーエンドポイントが複数の場合、ジョブに必要な入力ファイルが 1 つだけのときは、監視フォルダーのルートにそのファイルをコピーできます。

ジョブに複数の入力ファイルが含まれる場合、ユーザーは、すべての必要なファイルを含む監視フォルダー階層の外部にフォルダーを作成する必要があります。この新しいフォルダーには入力ファイルを含める必要があります（プロセスで必要になる場合は DDX ファイルも含めます）。ジョブフォルダーを構築したら、ユーザーはそのジョブフォルダーを監視フォルダーの入力フォルダーにコピーする必要があります。

NOTE
アプリケーションサーバーには監視フォルダー内のファイルを削除する権限を付与してください。AEM forms がスキャン済みファイルを入力フォルダーから削除できない場合、関連付けられたプロセスが無制限に呼び出されます。

監視フォルダーの出力 watched-folder-output

入力が 1 つのフォルダーであり、出力が複数のファイルで構成されている場合、AEM Forms では、入力フォルダーと同じ名前が付けられた出力フォルダーが作成され、そのフォルダーに出力ファイルがコピーされます。Output プロセスからの出力などのキーと値のペアを含むドキュメントマップで出力が構成されている場合、キーは出力ファイル名として使用されます。

エンドポイントプロセスによって生成される出力ファイル名には、英字、数字およびファイル拡張子の前のピリオド（.）以外の文字を含めることはできません。それ以外の文字は、AEM Forms によって 16 進数値に変換されます。

クライアントアプリケーションでは、監視フォルダーの結果フォルダーから結果ドキュメントを取得します。プロセスエラーは監視フォルダーの失敗フォルダーに記録されます。

監視フォルダーの仕組み how-watched-folder-works

監視フォルダーモジュールには、次のサービスが含まれています。

  • 監視フォルダーサービス
  • provider.file_scan_service
  • provider.file_write_results_service

上記のサービスに加えて、監視フォルダーには、ジョブをスケジュールするためのスケジューラーサービスや、ターゲットサービスの非同期呼び出しに対応する Job Manager サービスなど、他のサービスにも依存します。

監視フォルダーによる呼び出し要求の処理方法 how-watched-folder-processes-an-invocation-request

監視フォルダーサービスでは、エンドポイントの作成、更新および削除を処理します。管理者がエンドポイントを作成すると、エンドポイントは指定の繰り返し間隔または Cron 形式に基づいてスケジューラーサービスによってトリガーされるようにスケジュールされます。

次の図は、監視フォルダーによる呼び出し要求の処理方法を示しています。

en_watchedfolder

監視フォルダーを使用してサービスを呼び出すプロセスは次のとおりです。

  1. クライアントアプリケーションでは、ファイルやフォルダーを監視フォルダーの入力フォルダーに配置します。

  2. ジョブスキャンの間隔が発生すると、スケジューラーサービスによって provider.file_scan_service が呼び出され、入力フォルダー内のファイルまたはフォルダーが処理されます。

  3. provider.file_scan_service で次のタスクが実行されます。

    • 「ファイルパターンを含める」設定に一致するファイルまたはフォルダーがないか入力フォルダーをスキャンし、「ファイルパターンを除外」設定に一致するファイルまたはフォルダーを除外します。最も古いファイルまたはフォルダーが最初に取得されます。待機時間より古いファイルやフォルダーも取得されます。1 回のスキャンで処理されるファイルまたはフォルダーの数は、バッチサイズによって決まります。ファイルパターンについて詳しくは、ファイルパターンについてを参照してください。バッチサイズの設定について詳しくは、監視フォルダーサービスの設定を参照してください。
    • 処理対象のファイルまたはフォルダーを取得します。処理対象のファイルまたはフォルダーが完全にダウンロードされない場合は、次回のスキャンで取得します。フォルダーが完全にダウンロードされた状態にするには、管理者は「ファイルパターンを除外」設定を使用して名前付きのフォルダーを作成する必要があります。そのフォルダーにファイルをすべて含めた後、フォルダーの名前を「ファイルパターンを含める」に指定したパターンに合うように変更します。この手順によって、サービスを呼び出すために必要なすべてのファイルがこのフォルダーに含まれるようになります。フォルダーが完全にダウンロードされていることを確認する方法について詳しくは、監視フォルダーのヒントとテクニックを参照してください。
    • 処理対象として選択したファイルまたはフォルダーをステージフォルダーに移動します。
    • エンドポイント入力パラメーターマッピングに基づいて、ステージフォルダー内のファイルやフォルダーを適切な入力に変換します。入力パラメーターのマッピングの例については、監視フォルダーのヒントとテクニックを参照してください。

  4. エンドポイントに設定されているターゲットのサービスが、同期または非同期で呼び出されます。ターゲットのサービスを呼び出すには、エンドポイント用に設定されているユーザー名およびパスワードを使用します。

    • 同期呼び出しでは、ターゲットサービスを直接呼び出し、応答を直ちに処理します。
    • 非同期呼び出しでは、ターゲットサービスは Job Manager サービス経由で呼び出されます。Job Manager サービスは要求をキューに配置します。続いて Job Manager サービスは、provider.file_write_results_service を呼び出して結果を処理します。

  5. provider.file_write_results_service は、ターゲットサービス呼び出しの応答または失敗を処理します。処理が正常に終了すると、その出力がエンドポイントに設定された結果フォルダーに保存されます。正常終了時に結果を保存するようにエンドポイントが設定されている場合、provider.file_write_results_service はソースも保存します。

    ターゲットサービス呼び出しが失敗すると、provider.file_write_results_service は失敗の理由を failure.log ファイルに記録し、そのファイルを失敗フォルダーに配置します。失敗フォルダーは、エンドポイントに指定された設定パラメーターに基づいて作成されます。管理者がエンドポイント設定に「エラー時に保存」オプションを設定している場合、provider.file_write_results_service はソースファイルを失敗フォルダーにコピーします。失敗フォルダーからファイルを回復する方法について詳しくは、失敗ポイントおよび回復を参照してください。

監視フォルダーエンドポイントの設定 watched-folder-endpoint-settings

監視フォルダーエンドポイントを設定するには、次の設定を使用します。

名前：（必須）エンドポイントを識別します。< は含めないでください。含めると、Workspace に表示される名前の一部が省略されます。エンドポイント名として URL を入力する場合は、RFC1738 で指定された構文規則に準拠していることを確認します。

説明： エンドポイントの説明。< は含めないでください。含めると、Workspace に表示される説明の一部が省略されます。

パス：：（必須）監視フォルダーの場所を指定します。クラスター環境では、クラスター内のすべてのコンピューターからアクセスできる共有ネットワークフォルダーを指定する必要があります。

非同期： 呼び出しを非同期型にするか同期型にするかを指定します。デフォルト値は asynchronous（非同期）です。長期間有効なプロセスでは非同期を使用し、一過性のプロセスまたは短期間のみ有効なプロセスでは同期を使用することをお勧めします。

Cron 式： Cron 式を使用して監視フォルダーをスケジュールする必要がある場合は Cron 式を入力します。これを設定すると、「繰り返し間隔」は無視されます。

繰り返し間隔： ​入力用の監視フォルダーをスキャンする間隔（秒）。「ジョブ数を制限」が有効になっていない場合は、「繰り返し間隔」を平均的なジョブを処理する時間よりも大きい値に設定する必要があります。そうしないと、システムが過負荷の状態になる可能性があります。デフォルト値は 5 です。追加情報については、「バッチサイズの説明」を参照してください。

繰り返し回数： ​監視フォルダーでフォルダーまたはディレクトリをスキャンする回数。-1 を指定すると、無限にスキャンされます。デフォルト値は -1 です。

スロットル： ​このオプションを選択すると、AEM Forms で同時に処理できる監視フォルダーのジョブ数が制限されます。ジョブの最大数は、バッチサイズ値によって決まります（「ジョブ数の制限について」を参照）。

ユーザー名：（必須）監視フォルダーからターゲットサービスを呼び出すときに使用されるユーザー名です。デフォルト値は「SuperAdmin」です。

ドメイン名：（必須）ユーザーのドメイン。デフォルト値は「DefaultDom」です。

バッチサイズ： 1 回のスキャンで取得されるファイルまたはフォルダーの数を指定します。この設定を使用して、システムが過負荷の状態になるのを防ぎます。一度にスキャンするファイル数が多すぎる場合、クラッシュする可能性があります。デフォルト値は 2 です。

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

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

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

待機時間： ​フォルダーまたはファイルの作成後にスキャンを実行するまでの待機時間（ミリ秒単位）。例えば、待機時間が 3,600,000 ミリ秒（1 時間）のときに、1 分前にファイルが作成されたとすると、59 分以上が経過した後でこのファイルが取得されます。デフォルト値は 0 です。

この設定は、ファイルまたはフォルダーを入力フォルダーにコピーする処理を確実に完了するために役立ちます。例えば、処理の対象となるファイルサイズが大きく、そのファイルをダウンロードするのに 10 分かかる場合は、待機時間を 10 x 60 x 1000 ミリ秒に設定します。この設定により、ファイルが作成されてから 10 分が経過していない場合は、監視フォルダーはそのファイルをスキャンしなくなります。

ファイルパターンを除外： ​スキャンおよび取得の対象とするファイルとフォルダーを決めるために監視フォルダーで使用されるパターンのセミコロン（;）区切りのリスト。このパターンに当てはまるファイルまたはフォルダーは、スキャンの対象外となります。

この設定は、複数のファイルが存在するフォルダーが入力の場合に便利です。フォルダーの内容を、監視フォルダーの取得対象となる名前のフォルダーにコピーすることができます。これにより、フォルダーが入力フォルダーに完全にコピーされる前に監視フォルダーがフォルダーを取得することを回避できます。

次のように、除外するファイルパターンを指定できます。

  • 特定のファイル拡張子を持つファイル例： &ast;.dat, &ast;.xml, &ast;.pdf

  • data.&ast;次の名前のファイルとフォルダを除外します： data1、data2 など。

  • 次のような名前および拡張子が混在する式に一致するファイル。

    • Data[0-9][0-9][0-9].[dD][aA]'port'
    • &ast;。[dD][Aa]'port'
    • &ast;。[Xx][Mm][Ll]

ファイルパターンについて詳しくは、「ファイルパターンについて」を参照してください。

ファイルパターンを含める：（必須）スキャンおよび取得の対象とするファイルとフォルダーを決めるために監視フォルダーで使用されるパターンのセミコロン（;）区切りのリスト。例えば、「ファイルパターンを含める」が「input&ast;」の場合、名前が input&ast; に一致するすべてのファイルおよびフォルダーが取得されます。input1、input2 などの名前を持つファイルおよびフォルダーが含まれます。

デフォルト値は &ast; です。すべてのファイルとフォルダーが対象となります。

次のように、含めるファイルパターンを指定できます。

  • 特定のファイル拡張子を持つファイル例： &ast;.dat, &ast;.xml, &ast;.pdf

  • data.&ast; を指定すると、data1 や data2 などの名前を持つファイルおよびフォルダーが対象に含まれます。

  • 次のような名前および拡張子が混在する式に一致するファイル。

    • Data[0-9][0-9][0-9].[dD][aA]'port'
    • &ast;。[dD][Aa]'port'
    • &ast;。[Xx][Mm][Ll]

ファイルパターンについて詳しくは、「ファイルパターンについて」を参照してください。

結果フォルダー： ​保存結果を格納するフォルダー。結果がこのフォルダーに表示されない場合は、失敗フォルダーを確認してください。読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。絶対パスまたは相対パスを次のファイルパターンを使用して指定できます。

  • %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 になります。

絶対パスではなく相対パスを指定すると、結果フォルダーは監視フォルダーの中に作成されます。デフォルト値は「result/%Y/%M/%D/」であり、監視フォルダー内の結果フォルダーです。ファイルパターンについて詳しくは、「ファイルパターンについて」を参照してください。

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

保存用フォルダー： 正常にスキャンされ、取得されたファイルが格納される場所。相対パス、絶対パスまたは null のディレクトリパスを指定できます。「結果フォルダー」で説明したファイルパターンを使用できます。デフォルト値は preserve/%Y/%M/%D/ です。

失敗フォルダー： 失敗ファイルが保存されるフォルダーです。この場所は、常に監視フォルダーからの相対パスで指定します。「結果フォルダー」で説明したファイルパターンを使用できます。

読み取り専用ファイルは処理されず、失敗フォルダーに保存されます。

デフォルト値は failure/%Y/%M/%D/ です。

エラー時に保存： ​サービスで操作の実行に失敗した場合に入力ファイルを保存します。デフォルト値は true です。

重複したファイル名を上書き： ​この値を True に設定すると、結果フォルダーと保存用フォルダーにあるファイルが上書きされます。False に設定すると、ファイル名とフォルダー名に数字のインデックス接尾辞が付加されます。デフォルト値は false です。

クリア期間：（必須）結果フォルダー内にこの値より古いファイルまたはフォルダーがあると、それらは削除されます。この値の単位は日です。この設定は、結果フォルダーに常に空き容量を確保しておきたい場合に役立ちます。

-1 を指定すると、結果フォルダーの削除は行われません。デフォルト値は -1 です。

操作名：（必須）監視フォルダーエンドポイントに割り当てることができる操作のリストです。

入力パラメーターのマッピング： ​サービスおよび操作を処理するために必要な入力を設定するために使用します。使用できる設定は、監視フォルダーエンドポイントを使用するサービスによって異なります。入力には、次の 2 つの種類があります。

リテラル： ​監視フォルダーでは、フィールドに入力された値が表示どおりに使用されます。すべての基本 Java 型がサポートされます。例えば、String、long、int および Boolean などの入力が使用される API の場合、文字列は適切な型に変換され、サービスが呼び出されます。

変数： ​監視フォルダーでは、入力された値をファイルパターンとして使用して入力を取得します。例えば、パスワード暗号化サービスで、入力ドキュメントが PDF ファイルであることが必須の場合、ユーザーはファイルパターンとして *.pdf を使用できます。監視フォルダーでこのパターンに一致するすべてのファイルが取得され、各ファイルに対するサービスが呼び出されます。変数の使用時は、すべての入力ファイルがドキュメントに変換されます。Document を入力型として使用する API のみがサポートされます。

出力パラメーターのマッピング： ​サービスおよび操作の出力を設定するために使用します。使用できる設定は、監視フォルダーエンドポイントを使用するサービスによって異なります。

監視フォルダーの出力は、1 つのドキュメント、ドキュメントのリストまたはドキュメントのマップになります。その後、「出力パラメーターのマッピング」で指定されたパターンを使用して、これらの出力ドキュメントが結果フォルダーに保存されます。

NOTE
結果が一意の出力ファイル名になる名前を指定すると、パフォーマンスが向上します。例えば、サービスによって 1 つの出力ドキュメントが返され、「出力パラメーターのマッピング」により、これが %F.%E（入力ファイルのファイル名と拡張子）にマッピングされる場合を考えてみます。この場合、ユーザーが 1 分ごとに同じ名前のファイルを配置したときに、結果フォルダーが result/%Y/%M/%D に設定されており、「重複したファイル名を上書き」設定が無効になっていると、監視フォルダーは重複したファイル名を解決しようとします。この重複したファイル名を解決するプロセスが、パフォーマンスに影響を与えることがあります。この状況では、「出力パラメーターのマッピング」を %F_%h_%m_%s_%l に変更して名前に時、分、秒、ミリ秒を追加するか、または配置されるファイルに必ず一意の名前を使用すると、パフォーマンスが向上する可能性があります。

ファイルパターンについて about-file-patterns

管理者は、サービスを呼び出すことができるファイルのタイプを指定できます。監視フォルダーごとに複数のファイルパターンを作成できます。ファイルパターンは、次のファイルプロパティのいずれかになります。

  • 特定の拡張子をファイル名に持つファイル。例えば、.dat、.xml、*.pdf

  • 特定の名前を含むファイル。例えば、data。&ast;

  • 次のような名前および拡張子が混在する式に一致するファイル。

    • Data[0-9][0-9][0-9].[dD][aA]'port'
    • &ast;。[dD][Aa]'port'
    • &ast;。[Xx][Mm][Ll]

管理者は、結果を保存する出力フォルダーのファイルパターンを定義できます。出力フォルダー（結果、保存、失敗）には、次のファイルパターンのいずれでも指定できます。

  • %Y = 年（4 桁表記）
  • %y = 年（下 2 桁）
  • %M = 月
  • %D =日（1～31）
  • %d = 日（通日）
  • %h = 時
  • %m = 分
  • %s = 秒
  • %R = 乱数（0～9）
  • %J = ジョブ名

例えば、結果フォルダーへのパスは C:\Adobe\Adobe_Experience_Manager_forms\BarcodedForms\%y\%m\%d のようになります。

出力パラメーターのマッピングでは、さらに次のパターンを指定できます。

  • %F = ソースファイル名
  • %E = ソースファイル拡張子

出力パラメーターのマッピングパターンが「File.separator」（つまり、パスセパレーター）で終わる場合、フォルダーが作成され、コンテンツがそのフォルダーにコピーされます。パターンが「File.separator」で終わらない場合、コンテンツ（結果ファイルまたはフォルダー）がその名前で作成されます。出力パラメーターのマッピングについて詳しくは、監視フォルダーのヒントとテクニックを参照してください。

ジョブ数の制限について about-throttling

監視フォルダーエンドポイントのジョブ数の制限が有効な場合、同時に処理できる監視フォルダーのジョブ数は制限されます。ジョブの最大数はバッチサイズ値によって決まり、監視フォルダーエンドポイントでも設定できます。ジョブ数の制限に達すると、監視フォルダーの入力ディレクトリにドキュメントが入ってもポーリングされません。また、このようなドキュメントは、他の監視フォルダージョブが完了し、別のポーリングが実施されるまで、入力ディレクトリに残ります。同期処理がある場合、ジョブが単一のスレッドで連続処理されたとしても、1 回のポーリングで処理された全ジョブがジョブ数の制限に含められます。

NOTE
ジョブ数の制限がクラスターに合わせて調整されることはありません。ジョブ数の制限が有効である場合、クラスター全体で同時に処理するジョブの数がバッチサイズに指定されている数を超えることはありません。この制限はクラスター全体に及ぶものであり、クラスターの各ノードに固有のものではありません。例えば、バッチサイズが 2 の場合、単一のノードがジョブを 2 つ処理するとジョブ数の制限に達するため、どちらかのジョブが完了するまで他のノードは入力ディレクトリをポーリングしません。

ジョブ数制限の仕組み how-throttling-works

監視フォルダーは、繰り返し間隔ごとに入力フォルダーをスキャンし、バッチサイズに指定されている数だけファイルを取得し、そのファイルごとにターゲットのサービスを呼び出します。例えば、バッチサイズがスキャンごとに 4 である場合、監視フォルダーはファイルを 4 つ取得し、呼び出し要求を 4 つ作成し、ターゲットのサービスを呼び出します。これらの要求が完了する前に、監視フォルダーを呼び出すと、前回の 4 つのジョブが完了しているかどうかに関係なく、再度 4 つのジョブを開始します。

ジョブ数の制限を有効にすると、前回のジョブが完了していない場合は、監視フォルダーが新たにジョブを呼び出さなくなります。監視フォルダーは、進行中のジョブを検出し、バッチサイズから進行中のジョブを差し引いた値に基づいて新しいジョブを処理します。例えば、2 回目の呼び出しを実行したとき、完了したジョブの数が 3 つで、まだ進行中のジョブが 1 つある場合、監視フォルダーはジョブを 3 つのみ呼び出します。

  • 監視フォルダーは、ステージフォルダーに存在しているファイルの数に基づいて進行中のジョブがいくつあるかを判断します。ステージフォルダーにファイルが未処理のまま残っている場合、監視フォルダーはそれ以上ジョブを呼び出しません。例えば、バッチサイズが 4 で、3 つのジョブが停止している場合、監視フォルダーは以降の呼び出しでジョブを 1 つのみ呼び出します。ステージフォルダーにファイルが未処理のまま残る原因として、いくつかのシナリオが考えられます。ジョブが停止している場合、管理者は forms ワークフローの管理ページでプロセスを終了できるため、監視フォルダーはステージフォルダーからファイルを移動することができます。
  • 監視フォルダーがジョブを呼び出す前に Forms サーバーがダウンした場合は、管理者がステージフォルダーからファイルを移動できます。詳しくは、失敗ポイントおよび回復を参照してください。
  • サービスが正しい順序で開始されず、Job Manager サービスのコールバックが発生したとき、Forms サーバーが動作している一方で監視フォルダーが動作していない場合は、管理者がステージフォルダーからファイルを移動できます。詳しくは、失敗ポイントおよび回復を参照してください。

パフォーマンスおよびスケーラビリティ performance-and-scalability

監視フォルダーは、1 つのノードにフォルダーを合計 100 個まで提供できます。監視フォルダーのパフォーマンスは、Forms サーバーのパフォーマンスによって決まります。非同期呼び出しの場合、パフォーマンスはシステム負荷および Job Manager キューにあるジョブに左右される割合が高くなります。

監視フォルダーのパフォーマンスを高めるには、クラスターにノードを追加します。監視フォルダージョブが、Quartz スケジューラーのほか、非同期リクエストの場合にはジョブマネージャーサービスによって、各クラスターノードに分散されます。すべてのジョブがデータベースに保存されます。

監視フォルダーによるジョブスケジュールの作成、取り消しおよび再作成は、スケジューラーサービスに依存しています。スケジューラーサービススレッドプールを共有するサービスにはこのほか、イベント管理サービス、ユーザー管理サービス、メールプロバイダーサービスなどがあります。監視フォルダーのパフォーマンスに影響を与えることがあります。これらのサービスが一斉にスケジューラーサービススレッドプールの使用を開始した場合には、このスレッドプールの調整が必要になります。

クラスターの監視フォルダー watched-folders-in-a-cluster

クラスターでは、Quartz スケジューラーおよびジョブマネージャーサービスによって、監視フォルダーのロードバランシングおよびフェイルオーバーを実現しています。Quartz クラスターの動作について詳しくは、Quartz のドキュメントを参照してください。

監視フォルダーは、ポーリングごとに主に次の 3 つのタスクを実行します。

  • フォルダーのスキャン
  • ターゲットサービスの呼び出し
  • 結果の処理

ロードバランシングおよびフェイルオーバーの動作は、監視フォルダーが同期呼び出し用に設定されているのか、それとも非同期呼び出し用に設定されているのかによって異なります。

クラスターの同期監視フォルダー synchronous-watched-folder-in-a-cluster

同期呼び出しの場合、Quartz ロードバランサーによって、どのノードがポーリングイベントを取得するかが決まります。ポーリングイベントを取得したノードが、フォルダーのスキャン、ターゲットサービスの呼び出し、結果の処理のいずれのタスクも実行します。

en_synchwatchedfoldercluster

同期呼び出しの場合、あるノードが失敗すると、Quartz スケジューラーは新しいポーリングイベントを他のノードに送信します。失敗したノードで開始された呼び出しは失われます。失敗したジョブに関連付けられているファイルを回復する方法について詳しくは、失敗ポイントおよび回復を参照してください。

クラスターの非同期監視フォルダー asynchronous-watched-folder-in-a-cluster

非同期呼び出しの場合、Quartz ロードバランサーによって、どのノードがポーリングイベントを取得するかが決まります。ポーリングイベントを取得したノードは、リクエストをジョブマネージャーサービスキューに配置して、入力フォルダーのスキャンおよびターゲットサービスの呼び出しを行います。続いてジョブマネージャーサービスのロードバランサーが、呼び出しリクエストを処理するノードを決定します。ノード A が呼び出しリクエストを作成したノードであっても、ノード B がリクエストを処理することになる場合があります。また、呼び出しリクエストを開始したノードが、リクエストも処理することになる場合があります。

en_asynchwatchedfoldercluster

非同期呼び出しの場合、あるノードが失敗すると、Quartz スケジューラーは新しいポーリングイベントを他のノードに送信します。失敗したノードで作成された呼び出しリクエストは、ジョブマネージャーサービスキューにあり、他のノードに送信されて処理されることになります。呼び出しリクエストが作成されていないファイルはステージフォルダーに残ります。失敗したジョブに関連付けられているファイルを回復する方法について詳しくは、失敗ポイントおよび回復を参照してください。

失敗ポイントおよび回復 failure-points-and-recovery

ポーリングイベントごとに、監視フォルダーは入力フォルダーをロックし、「ファイルパターンを含める」に一致するファイルをステージフォルダーに移動してから、入力フォルダーのロックを解除します。ロックは、2 つのスレッドが同じファイルを取得して同時に処理することを防ぐために必要となります。このような状況が発生する可能性は、繰り返し間隔が短く、バッチサイズを大きくしていると高くなります。ファイルがステージフォルダーに移動されると、入力フォルダーのロックが解除され、他のスレッドが入力フォルダーをスキャンできるようになります。この手順により、あるスレッドがファイルを処理している間に他のスレッドがスキャンを実行できるため、高いスループットを実現できます。

ファイルがステージフォルダーに移動すると、ファイルごとに呼び出しリクエストが作成され、ターゲットのサービスが呼び出されます。監視フォルダーがステージフォルダー内のファイルを回復できない場合があります。

  • 監視フォルダーが呼び出しリクエストを作成する前にサーバーがダウンした場合、ステージフォルダー内のファイルはステージフォルダーに残り、回復されません。
  • 監視フォルダーがステージフォルダー内のファイルごとに呼び出しリクエストを正常に作成した後でサーバーがクラッシュした場合、呼び出しタイプに基づいて動作が次の 2 つに分かれます。

同期：監視フォルダーがサービスを同期的に呼び出すように設定されている場合、ステージフォルダー内のファイルはすべて未処理のままステージフォルダーに残ります。

非同期：この場合、監視フォルダーはジョブマネージャーサービスに依存します。Job Manager サービスが監視フォルダーをコールバックした場合、ステージフォルダー内のファイルは呼び出しの結果に基づいて保存フォルダーまたは失敗フォルダーに移動されます。Job Manager サービスが監視フォルダーをコールバックしない場合、ファイルは未処理のままステージフォルダーに残ります。この状況が発生するのは、Job Manager がコールバックしようとしたときに監視フォルダーが動作していない場合です。

ステージフォルダーに未処理のまま残っているソースファイルの回復 recovering-unprocessed-source-files-in-the-stage-folder

監視フォルダーでステージフォルダー内のソースファイルを処理できない場合、未処理のファイルを回復できます。

  1. アプリケーションサーバーまたはノードを再起動します。

  2. （オプション）監視フォルダーが新しい入力ファイルを処理できないようにします。この手順をスキップすると、どのファイルがステージフォルダーに未処理のまま残っているのかを判断するのが非常に難しくなります。監視フォルダーが新しい入力ファイルを処理できないようにするには、次のタスクのいずれかを実行します。

    • アプリケーションおよびサービスで、監視フォルダーエンドポイントに対する「ファイルパターンを含める」パラメーターを新しい入力ファイルのいずれにも一致しない値に変更します（例えば、「NOMATCH」と入力します）。
    • 新しい入力ファイルを作成しているプロセスを休止します。

    AEM forms がすべてのファイルを回復して処理するまで待機します。ファイルのほとんどが回復され、新しい入力ファイルは正しく処理されます。監視フォルダーがファイルを回復し、処理するまでの待機時間の長さは、呼び出す操作の長さおよび回復するファイルの数によって異なります。

  3. 処理できないファイルを特定します。適切な待機時間が経過し、前の手順を完了した上、ステージフォルダーに未処理のファイルが残っている場合は、次の手順に進みます。

    note note
    NOTE
    ステージディレクトリのファイルの日付およびタイムスタンプを確認できます。ファイルの数および通常の処理時間から、どのファイルが古く、停止していると考えられるかを判断できます。

  4. ステージディレクトリから入力ディレクトリに未処理のファイルをコピーします。

  5. 手順 2 で監視フォルダーが新しい入力ファイルを処理できないようにした場合は、「ファイルパターンを含める」を前の値に戻すか、または無効にしたプロセスを再度有効にします。

監視フォルダーのセキュリティに関する考慮事項 security-considerations-for-watched-folders

どの監視フォルダーにも、ユーザー名およびパスワードが設定されています。この資格情報は、サービスを呼び出すときに使用されます。共有フォルダーは基礎となるセキュリティファイルシステムで保護されているため、監視フォルダーの所有者のみが共有フォルダーにアクセスできます。

監視フォルダーのヒントとテクニック tips-and-tricks-for-watched-folders

ここでは、監視フォルダーエンドポイントを設定する際のヒントとテクニックを示します。

  • Windows で、画像ファイルを処理するための監視フォルダーがある場合、「ファイルパターンを含める」オプションまたは「ファイルパターンを除外」オプションに値を指定して、Windows により自動生成される Thumbs.db ファイルが監視フォルダーによってポーリングされないようにする必要があります。

  • Cron 式を指定した場合、繰り返し間隔は無視されます。Cron 式の使用方法は、Quartz オープンソースジョブスケジュールシステムのバージョン 1.4.0 に基づきます。

  • バッチサイズは、監視フォルダーの各スキャンで取得するファイルまたはフォルダーの数です。バッチサイズを 2 に設定している場合、10 個のファイルまたはフォルダーが監視フォルダーの入力フォルダーに入っても、各スキャンではそのうち 2 個のみが取得されます。繰り返し間隔に指定されている時間の後に発生する次回のスキャンでは、次の 2 つのファイルが取得されます。

  • ファイルパターンでは、管理者は、ファイルパターンを指定するためのワイルドカードパターンのサポートを追加した正規表現を指定できます。監視フォルダーでは正規表現が変更されており、&ast;.&ast; や &ast;.pdf などのワイルドカードパターンがサポートされます。このようなワイルドカードパターンは、正規表現ではサポートされていません。

  • 監視フォルダーは、入力フォルダーをスキャンして入力の有無を調べますが、ソースファイルまたはソースフォルダーの処理を開始する前に、ソースファイルやソースフォルダーが完全に入力フォルダーにコピーされているかどうかを認識しません。ソースファイルやソースフォルダーを完全に監視フォルダーの入力フォルダーにコピーしてから、ソースファイルまたはフォルダーを取得するようにするには、次のタスクを実行します。

    • 待機時間、つまり最後に変更されてから監視フォルダーが待機する時間（ミリ秒単位）を使用します。処理するファイルが大きい場合は、この機能を使用します。例えば、ファイルのダウンロードに 10 分かかる場合は、待機時間を 10 x 60 x 1000 ミリ秒に指定します。これで、監視フォルダーは生成されてから 10 分経っていないファイルを取得しないようになります。
    • 「ファイルパターンを除外」および「ファイルパターンを含める」を使用します。例えば、「ファイルパターンを除外」を ex*、「ファイルパターンを含める」を in* とした場合、監視フォルダーは「in」で始まるファイルを取得し、「ex」で始まるファイルを取得しません。大きなファイルまたはフォルダーをコピーするには、まず「ex」で始まるようにファイルまたはフォルダーの名前を変更します。「ex」という名前のファイルまたはフォルダーが監視フォルダーに完全にコピーされたら、その名前を「in&ast;」に変更します。

  • クリア期間を使用して、結果フォルダーを空にしておきます。監視フォルダーは、クリア期間に設定されている期間よりも古いファイルをすべてクリーンアップします。期間は日単位です。

  • 監視フォルダーエンドポイントを追加した場合、操作名を選択すると、入力パラメーターのマッピングが入力されます。操作を入力するたびに、入力パラメーターのマッピングフィールドが 1 つ生成されます。ここでは、入力パラメーターのマッピングの例をいくつか示します。

    • com.adobe.idp.Document 入力の場合：サービス操作の入力タイプが Document である場合、マッピングの種類を Variable に指定できます。監視フォルダーは、入力パラメーター用に指定されているファイルパターンに基づいて監視フォルダーの入力フォルダーから入力を取得します。管理者が *.pdf をパラメーターとして指定した場合、拡張子が .pdf の各ファイルが取得され、com.adobe.idp.Document に変換されてから、サービスが呼び出されます。
    • java.util.Map 入力の場合：サービス操作の入力タイプが Map である場合、マッピングの種類を Variable に指定し、*.pdf のようなパターンを使用してマッピング値を入力できます。例えば、サービスが 1.pdf や 2.pdf など入力フォルダー内のファイルを表す 2 つの com.adobe.idp.Document オブジェクトのマップを必要としているとします。監視フォルダーは、キーがファイル名で、値が com.adobe.idp.Document であるマップを作成します。
    • java.util.List 入力の場合：サービス操作の入力タイプが List である場合、マッピングの種類を Variable に指定し、*.pdf のようなパターンを使用してマッピング値を入力できます。PDF ファイルが入力フォルダーに入ると、監視フォルダーは PDF ファイルを表す com.adobe.idp.Document オブジェクトのリストを作成し、ターゲットのサービスを呼び出します。
    • java.lang.String の場合：管理者にはオプションが 2 つ用意されています。1 つは、マッピングの種類を Literal に指定し、マッピング値に hello. などの文字列を入力することです。監視フォルダーは、文字列 hello でサービスを呼び出します。もう 1 つは、マッピングの種類を Variable に指定し、*.txt のようなパターンを使用してマッピング値を入力することです。後者の場合、拡張子が .txt のファイルは、サービスを呼び出す文字列となるドキュメントとして読み込まれます。
    • Java プリミティブ型：マッピングの種類を Literal に指定し、値を指定できます。監視フォルダーは、指定の値でサービスを呼び出します。

  • 監視フォルダーはドキュメントを扱えるようになっています。サポートされている出力は、com.adobe.idp.Document、org.w3c.Document、org.w3c.Node のほか、これらのタイプのリストおよびマップです。他のタイプでは、失敗フォルダーに失敗した出力が生成されます。

  • 結果が結果フォルダーにない場合は、失敗フォルダーを確認して、失敗が発生したかどうかを確認します。

  • 監視フォルダーは、非同期モードで使用した場合に最も有効に機能します。このモードでは、監視フォルダーはキューに呼び出しリクエストを配置し、コールバックします。キューは非同期に処理されます。非同期オプションを設定しないと、監視フォルダーは同期的にターゲットのサービスを呼び出すため、プロセスエンジンはサービスがリクエストを完了し、結果が生成されるまで待機します。ターゲットのサービスがリクエストを処理するのに長い時間がかかる場合、監視フォルダーはタイムアウトエラーを受け取ることがあります。

  • 読み込みおよび書き出し操作用の監視フォルダーの作成では、ファイル拡張子を抽象化できません。監視フォルダーを使用して Form Data Integration サービスを呼び出すときに、出力ファイルのファイル名の拡張子の種類が、ドキュメントオブジェクトタイプで意図している出力形式と一致しないことがあります。例えば、書き出し操作を呼び出す監視フォルダーに対する入力ファイルが、データを含む XFA フォームの場合、出力は XDP データファイルである必要があります。正しいファイル名の拡張子が設定された出力ファイルを取得するため、出力パラメーターマッピングでその拡張子を指定できます。この例では、出力パラメーターマッピングに %F.xdp を使用できます。

  • 監視フォルダーは、まだフォルダーに完全にコピーされていない入力ファイルを処理することがあります。Windows とは異なり、UNIX ではファイルのロックは必須ではありません。このため、ファイルが監視フォルダーにコピーされているとき、ファイルのコピーが完了するのを待たずに監視フォルダーによってファイルがステージに移動される場合があります。その結果、入力ファイルの一部のみしか処理されません。現時点では 2 つの対処方法があります。

    • 対処方法 1

      1. 「ファイルパターンを除外」に emp&ast;.ps などのパターンを指定します。
      2. temp で始まるファイル（temp1.ps など）を監視フォルダーにコピーします。
      3. ファイルを監視フォルダーに完全にコピーした後で、「ファイルパターンを含める」に指定されているパターンに合わせてファイル名を変更します。監視フォルダーによって完全なファイルがステージに移動されます。

    • 対処方法 2

      ファイルを監視フォルダーにコピーするのに要する最大時間がわかっている場合は、その時間を「待機時間」に秒単位で指定します。監視フォルダーは、指定された時間だけ待機してから、ファイルをステージに移動します。

      Windows では、1 つのスレッドでファイルの書き込みが行われるときにはファイルがロックされるので、ファイルについてはこのような問題は発生しません。ただし、Windows でもフォルダーについては同じ問題が発生します。フォルダーの場合は、対処方法 1 の手順に従う必要があります。

  • 監視フォルダーの保存用フォルダー名のエンドポイント属性が null のディレクトリパスに設定されていると、通常は空になるステージングディレクトリが空になりません。このディレクトリには、処理済みのファイルと一時フォルダーが含まれています。

監視フォルダーに関するサービス固有の推奨事項 service-specific-recommendations-for-watched-folders

どのサービスについても、監視フォルダーが処理対象の新しいファイルおよびフォルダーを取得する数が AEM Forms サーバーで処理できるジョブの数を超えないように、監視フォルダーのバッチサイズおよび繰り返し間隔を調整する必要があります。実際に使用するパラメーターは、設定している監視フォルダーの数、監視フォルダーを使用しているサービスの種類、ジョブによるプロセッサーの使用率によって決まります。

Generate PDF サービスのレコメンデーション generate-pdf-service-recommendations

  • Generate PDF サービスでは、次に挙げるファイルタイプのファイルを一度に 1 つだけ変換できます。Microsoft Word、Microsoft Excel、Microsoft PowerPoint、Microsoft Project、AutoCAD、Adobe Photoshop®、Adobe FrameMaker®、Adobe PageMaker® の各ファイルです。いずれも長時間続くジョブなので、バッチサイズを低く設定しておいてください。また、クラスターに含めるノードを増やした場合は、繰り返し間隔を長くしてください。
  • PostScript（PS）、Encapsulated PostScript（EPS）および画像ファイルタイプの場合、Generate PDF サービスでは複数のファイルを並行して処理できます。サーバーの容量およびクラスター内のノード数に応じて、セッション Bean プールサイズを慎重に調整してください（この値で並行して実行できる変換処理の数が決まります）。次に、変換しようとしているファイルタイプのセッション Bean プールサイズに等しくなるまでバッチサイズの値を増やします。ポーリング頻度は、クラスターのノード数によって決まります。ただし、Generate PDF サービスはこの種のジョブをきわめて迅速に処理するので、繰り返し間隔を 5 や 10 など低い値に設定してもかまいません。
  • Generate PDF サービスでは OpenOffice ファイルを一度に 1 つしか変換できないものの、変換はきわめて高速に行われます。PS、EPS および画像の変換で説明した上述のロジックは、OpenOffice の変換にも当てはまります。
  • クラスターで負荷を均等に分散するには、バッチサイズを低く抑えたまま、繰り返し間隔を長くします。

Barcoded Forms サービスの推奨事項 barcoded-forms-service-recommendations

  • バーコードフォーム（小さいファイル）の処理で最良のパフォーマンスを得るには、バッチサイズに 10、繰り返し間隔に 2 を入力します。

  • 数多くのファイルが入力フォルダーに配置されていると、thumbs.db という隠しファイルに関するエラーが発生することがあります。このため、インクルードファイルの「ファイルパターンを含める」を、入力変数用に指定されているのと同じ値（例：*.tiff）に設定することをお勧めします。これで、監視フォルダーが DB ファイルを処理できないようになります。

  • Barcoded Forms サービスは通常 1 つのバーコードを処理するのに約 0.5 秒かかるので、通常はバッチサイズを 5、繰り返し間隔を2 とすれば十分です。

  • 監視フォルダーは、プロセスエンジンがジョブを終了するのを待たずに、新しいファイルまたはフォルダーを取得します。プロセスエンジンは、監視フォルダーのスキャンおよびターゲットサービスの呼び出しを続けます。この動作がプロセスエンジンの負荷を増大させ、リソースの問題およびタイムアウトが発生することがあります。繰り返し間隔およびバッチサイズを使用して、監視フォルダーの入力を制限するようにしてください。監視フォルダーを増やしたり、エンドポイントでジョブ数の制限を有効にしたりする場合は、繰り返し間隔を長くしてバッチサイズを小さくすることができます。ジョブ数の制限について詳しくは、ジョブ数の制限についてを参照してください。

  • 監視フォルダーは、ユーザー名およびドメイン名で指定されているユーザーとして動作します。直接呼び出す場合やプロセスが短期間のみ有効である場合、監視フォルダーはこのユーザーとしてサービスを呼び出します。長期間有効なプロセスは、システムコンテキストで呼び出されます。管理者は、監視フォルダーのオペレーティングシステムポリシーを設定して、アクセスを許可するユーザーおよび拒否するユーザーを決めることができます。

  • 結果フォルダー、失敗フォルダーおよび保存用フォルダーを編成するには、ファイルパターンを使用します（ファイルパターンについてを参照してください）。

  • 監視フォルダーでは、Quartz スケジューラーを利用して監視フォルダーをスキャンします。Quartz スケジューラーには、監視フォルダーをスキャンするためのスレッドプールがあります。監視フォルダーの繰り返し間隔がきわめて短く（5 秒未満）、バッチサイズが大きい（3 以上）場合、競合状態が発生することがあります。競合状態が発生すると、1 つのファイルが 2 つの Quartz スレッドによって取得されます。

    • 1 つのスレッドは正しくファイルを探し、そのファイルでターゲットのサービスを呼び出します。
    • もう 1 つのスレッドはファイルを認識しますが、ファイルが有効であるかどうかを調べようとして（ファイルを読み書きしようとして）失敗し、ファイルが読み取り専用なので処理できないことを示す誤ったエラーが発生します。このような状態は、繰り返し間隔が短く、バッチサイズが大きい場合にのみ発生します。
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2