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

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

Watched Folder サービスの設定 configuring-the-watched-folder-service

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

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

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

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

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

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

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

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

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

ユーザーが監視フォルダーとやり取りする方法 how-users-interact-with-watched-folders

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

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

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

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

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

エンドポイントプロセスによって生成される出力ファイル名に、文字、数字、ピリオド (.) 以外の文字を含めることはできません を追加します。 AEM forms は、その他の文字を 16 進数値に変換します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

大量のファイルがドロップされる場合は、バッチサイズを大きくします。 例えば、監視フォルダーエンドポイントによって呼び出されたサービスが 1 分あたり 700 個のファイルを処理し、ユーザーが同じ速度で入力フォルダーにファイルをドロップした場合、バッチサイズを 350 に設定し、繰り返し間隔を 30 秒に設定すると、監視フォルダーのパフォーマンスが向上します。

ファイルが監視フォルダーに配置されると、入力内のファイルが一覧表示されます。これにより、スキャンが 1 秒ごとにおこなわれるとパフォーマンスが低下する可能性があります。 スキャン間隔を長くすると、パフォーマンスが向上します。 ドロップされるファイルの量が少ない場合は、それに応じて [ バッチサイズ ] と [ 繰り返し間隔 ] を調整します。 例えば、1 秒ごとに 10 個のファイルが配置される場合は、「繰り返し間隔」を 1 秒に、「バッチサイズ」を 10 に設定します。

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

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

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

この設定は、入力が複数のファイルを含むフォルダーの場合に役立ちます。 フォルダーの内容を、監視フォルダーで取得される名前のフォルダーにコピーできます。 これにより、フォルダーが入力フォルダーに完全にコピーされる前に、監視フォルダーが処理対象のフォルダーを取得するのを防ぎます。

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

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

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

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

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

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

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

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

絶対パスではなく相対パスを指定した場合、そのフォルダーは監視フォルダー内に作成されます。 デフォルト値は 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 のみがサポートされます。

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

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

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

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

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

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

出力パラメーターのマッピングでは、次のような追加のパターンも指定できます。

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

スロットルについて about-throttling

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

スロットルの仕組み how-throttling-works

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

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

パフォーマンスと拡張性 performance-and-scalability

監視フォルダーは、1 つのノード上で合計 100 個のフォルダーを提供できます。 監視フォルダーのパフォーマンスは、forms サーバーのパフォーマンスによって異なります。 非同期呼び出しの場合、パフォーマンスは、Job Manager キュー内のシステム負荷とジョブにより大きく依存します。

監視フォルダーのパフォーマンスは、ノードをクラスターに追加することで向上できます。 監視フォルダーのジョブは、Quartz スケジューラーによってクラスターノード間で、また、非同期要求の場合は Job Manager サービスによって分散されます。 すべてのジョブはデータベースに保持されます。

監視フォルダーでのジョブのスケジュール設定、スケジュール解除、再スケジュールは、スケジューラーサービスに依存します。 スケジューラーサービススレッドプールを共有する他のサービス（イベント管理サービス、User Manager サービス、Email Provider サービスなど）を使用できます。 これは監視フォルダーのパフォーマンスに影響を与える可能性があります。 スケジューラーサービススレッドプールの調整は、すべてのサービスが使用を開始する際に必要になります。

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

クラスターでは、監視フォルダーは Quartz スケジューラーと Job Manager サービスに依存して、ロードバランシングとフェイルオーバーをおこないます。 Quartz クラスターの動作について詳しくは、 Quartz ドキュメント.

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

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

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

同期呼び出しの場合、Quartz ロードバランサーは、ポーリングイベントを取得するノードを決定します。 ポーリングイベントを取得したノードは、次のすべてのタスクを実行します。フォルダーをスキャンし、ターゲットサービスを呼び出して、結果を処理します。

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

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

非同期呼び出しの場合、Quartz ロードバランサーは、ポーリングイベントを取得するノードを決定します。 ポーリングイベントを取得したノードは、Job Manager サービスキューにリクエストを配置することで、入力フォルダーをスキャンし、ターゲットサービスを呼び出します。 次に、Job Manager サービスのロードバランサーが、呼び出し要求を処理するノードを決定します。 ノード A が呼び出し要求を作成した場合でも、ノード B が最終的に要求を処理する可能性があります。 または、呼び出し要求を開始したノードも、要求を処理することになる場合があります。

非同期呼び出しの場合、あるノードが失敗すると、Quartz スケジューラーは新しいポーリングイベントを他のノードに送信します。 失敗したノードで作成された呼び出し要求は、Job Manager サービスキューに含まれ、他のノードに送信されて処理されます。 呼び出し要求が作成されないファイルは、ステージフォルダーに残ります。 失敗したジョブに関連付けられたファイルを復元する方法の詳細については、 障害点と回復.

障害点と回復 failure-points-and-recovery

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

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

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

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

ステージフォルダー内の未処理のソースファイルを復元しています recovering-unprocessed-source-files-in-the-stage-folder

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

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

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

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

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

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

すべてのサービスで、監視フォルダーのバッチサイズと繰り返し間隔を調整して、新しいファイルやフォルダーを監視フォルダーが取得する割合が、AEM forms サーバーで処理できるジョブの割合を超えないようにする必要があります。 実際に使用するパラメーターは、設定されている監視フォルダーの数、監視フォルダーを使用しているサービス、およびプロセッサーでのジョブの集中的な使用状況によって異なる場合があります。

Generate PDF サービスの推奨事項 generate-pdf-service-recommendations

barcoded forms サービスに関する推奨事項 barcoded-forms-service-recommendations