監視フォルダースタートポイントのプロパティ

Process Properties ビューを使用して、次の監視フォルダースタートポイントのプロパティを設定します。

一般

名前:
スタートポイントの名前です。名前は、管理コンソールのサービスの管理ページに表示されます。Workbench 開発者とサービス管理者の両方にとって意味のある名前を指定してください。

説明:
(オプション)スタートポイントの説明です。プロセスを編集する他の開発者への説明を指定します。入力したテキストは、管理コンソールのサービス管理ページで、対応するエンドポイントの説明としても表示されます。

パス:
AEM forms サーバー上の監視フォルダーの場所です。デフォルトのパスは、/WatchedFolders/application name/process name です。これらのフォルダーは、アプリケーションのデプロイメント時にサーバーマシンのルートに作成されます。クラスタ環境では、クラスタ内のすべてのコンピューターからアクセスできる共有ネットワークフォルダーを指定する必要があります。

Invoke Asynchronously:
プロセスが非同期に呼び出されるか、同期的に呼び出されるかを決定します。
  • このオプションは、非同期に呼び出す必要のある長期間有効なプロセスに対して選択します。

  • 同期的に呼び出す必要のある短期間有効なプロセスには、このオプションを選択しないでください。

デフォルトでは、このオプションが選択されています(非同期呼び出し)。

Domain Name:
プロセスの呼び出しに使用されるユーザーの User Management ドメインです。デフォルト値は DefaultDom です。このドメインは、AEM forms に対して作成されるデフォルトのドメインです。

User Name:
プロセスを呼び出すための AEM forms の名前です。ユーザーには、サービスユーザーロールが割り当てられている必要があります。この値はユーザー ID プロパティであり、AEM forms へのログインに使用する名前です。デフォルト値は「SuperAdmin」です。

サーバーの設定

ファイルの処理方法を指定するプロパティです。

注意: 結果フォルダー、保存用フォルダーおよび失敗フォルダーのサイズが小さいと、パフォーマンスが向上します。
Include File Pattern:
プロセスへの入力として使用されるファイルの名前と一致するパターンです。値では大文字と小文字が区別されます。デフォルト値の * を指定すると、すべてのファイルが含まれます。複数のパターンを指定するには、セミコロン(;)で区切ります。次の例で有効な値を示します。
  • *.pdf を指定すると、すべての PDF ファイルが含まれます。

  • *.pdf;*.doc を指定すると、すべての PDF ファイルと DOC ファイルが含まれます。

  • data を指定すると、data という名前のすべてのファイルが含まれます。

  • *.[dD][aA][Tt] を指定すると、.dat(大文字と小文字の区別なく)というファイル名拡張子のすべてのファイルが含まれます。例えば、このパターンでは、file1.Dat と file2.dAt という名前のファイルが両方とも含まれます。

Exclude File Pattern:
監視フォルダーで無視されるファイルの名前と一致するパターンです。値では大文字と小文字が区別されます。このプロパティは、複数のファイルを含むフォルダーが監視フォルダーにコピーされ、一部のファイルを無視する必要がある場合に役立ちます。

複数のパターンを指定するには、セミコロン(;)で区切ります。次の例で有効な値を示します。

  • *.bak を指定すると、.bak というファイル名拡張子のすべてのファイルが除外されます。

  • *.pdf;*.doc を指定すると、すべての PDF ファイルと DOC ファイルが除外されます。

  • data を指定すると、data という名前のすべてのファイルが除外されます。

  • *.[bB][aA][kK] を指定すると、.bak(大文字と小文字の区別なく)というファイル名拡張子のすべてのファイルが除外されます。例えば、file1.Bak および file2.BAK という名前のファイルはどちらも除外されます。

Result Folder:
プロセス出力値がファイルとして保存されるフォルダーです。このパスは、絶対パス、または監視フォルダーからの相対パスにすることができます。次の文字を含めることができます。これらの文字は実行時に展開されます。
%Y:
現在の年

%M:
現在の月

%D:
月初から数えた日

これらの文字は、フォルダーサイズを最小限に抑えるのに役立ちます。デフォルト値の result/%Y/%M/%D stores は、フォルダーサイズを最小限に抑えるために新しいフォルダーを毎日作成します。現在の日付が 2010 年 10 月 23 日の場合、結果は [watched folder] /results/2010/10/23 フォルダーに保存されます。

プロセスの結果がこのフォルダーに表示されない場合は、失敗フォルダーを確認してください。

Preserve Folder:
入力ファイルを使用するプロセスが正常に呼び出されたときに、入力ファイルがアーカイブされるフォルダーです。このパスは、絶対パス、または監視フォルダーからの相対パスにすることができます。次の文字を含めることができます。これらの文字は実行時に展開されます。
%Y:
現在の年

%M:
現在の月

%D:
月初から数えた日

これらの文字は、フォルダーサイズを最小限に抑えるのに役立ちます。デフォルト値の preserve/%Y/%M/%D は、フォルダーサイズを最小限に抑えるために新しいフォルダーを毎日作成します。現在の日付が 2010 年 10 月 23 日の場合、ファイルは [watched folder] /preserve/2010/10/23 フォルダーにアーカイブされます。入力ファイルがアーカイブされないようにするには、値を指定しないでください。

Failure Folder:
入力ファイルを使用するプロセスが正常に呼び出されなかったときに、入力ファイルがコピーされるフォルダーです。これらのファイルは、「Preserve On Failure」が選択されている場合にのみ保存されます。

このパスは、監視フォルダーからの相対パスである必要があります。次の文字を含めることができます。これらの文字は実行時に展開されます。

%Y:
現在の年

%M:
現在の月

%D:
月初から数えた日

これらの文字は、フォルダーサイズを最小限に抑えるのに役立ちます。デフォルト値の failure/%Y/%M/%D は、フォルダーサイズを最小限に抑えるために新しいフォルダーを毎日作成します。現在の日付が 2010 年 10 月 23 日の場合、失敗したファイルは [watched folder] /failure/2010/10/23 フォルダーに保存されます。

Preserve On Failure:
このオプションを選択すると、入力ファイルが呼び出しに失敗したプロセスの入力として使用されている場合に、その入力ファイルが失敗フォルダーに保存されます。

Overwrite Duplicate Filenames:
このオプションを選択すると、同じ名前の新しいファイルが保存されるときに結果フォルダーと保存用フォルダー内の既存のファイルが上書きされます。このオプションが選択されていない場合は、ファイルとフォルダーを区別するためにファイル名とフォルダー名に数値インデックスが追加されます。このオプションはデフォルトで選択されています。

Scheduling

AEM forms サーバーが監視フォルダーで新しいファイルをスキャンする頻度を指定するプロパティです。サーバーが 1 回のスキャンで処理するファイルの最大数も指定できます。

Scheduling プロパティの設定は、AEM forms サーバーの生産性に影響する場合があります。指定する値は、予測される新規ファイルの頻度によって決まります。例えば、30 秒ごとに 10 ファイルを受信すると予測される場合にフォルダーを毎秒スキャンすると、サーバーリソースが浪費されます。

Cron Expression:
AEM forms サーバーが監視フォルダーにおける新規ファイルをスキャンするタイミングを決定する cron 形式です。使用しているサーバーによって、cron 形式を使用するかどうかが決まります。デフォルトでは、このプロパティに値はありません。

この設定が設定されている場合、「Repeat Interval」プロパティの値は無視されます。cron 形式の定式化について詳しくは、 http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html を参照してください。

Repeat Interval:
AEM forms サーバーが新規ファイルをスキャンする時間間隔です。この値は秒単位です。デフォルト値の 5 では、サーバーが新規ファイルを 5 秒ごとにスキャンします。

「Throttle」設定が有効になっていない限り、平均的なジョブの処理にかかる時間よりも大きい値を指定してください。そうしないと、システムが過負荷になる可能性があります。

Repeat Count:
AEM forms サーバーが監視フォルダーをスキャンする回数です。-1 を指定すると、無限にスキャンされます。デフォルト値は -1 です。

Batch Size:
AEM forms サーバーが監視フォルダーをスキャンするたびに処理するファイルまたはフォルダーの最大数です。この値により、システムリソースの過負荷が防止されます。1 回のスキャンで処理するファイル数が多すぎると、サーバーのクラッシュの原因になることがあります。デフォルト値は 2 %です。

Wait Time:
AEM forms サーバーが監視フォルダーへのコピーを開始した後、フォルダーまたはファイルをスキャンする前に待機する時間(ミリ秒単位)です。例えば、待機時間が 36,000,000 ミリ秒(1 時間)で、ファイルが 1 分前に作成されたとします。ファイルは 59 分以上経過してから取得されます。デフォルト値は 0 です。

この設定は、大きなファイルまたはフォルダーの場合に役立ちます。待機時間が長いと、ファイルとフォルダーがプロセス入力値として使用される前に、ファイルとフォルダーのコピーが完了します。例えば、コピーに 10 分を要する大きなファイルには、10*60 *1000 ミリ秒の待機時間が必要です。

Throttle:
AEM forms サーバーで、1 回のスキャンで使用されるファイル数が Batch Size プロパティの値に従って制限されるようにするには、このオプションを選択します。

Purge Duration:
ファイルとフォルダーが削除される前に結果フォルダーに保持される日数です。このプロパティは、ファイルシステムの使用可能領域を管理するのに役立ちます。-1 を指定すると、ファイルは結果フォルダーに無限に残ります。デフォルト値は -1 です。

入力/出力

プロセス入力値の指定とプロセス出力値の格納用のプロパティです。

入力

プロセスの各入力変数の値を指定します。変数の型によって、値の表現方法が決まります。

Simple data types:
文字列、数値ベース型、xml、日時ベース型など、単純データ型の入力値にリテラル値を指定します。例えば、SomeText の文字列値として、 SomeText というテキストを指定します。

document, list of documents, and map of documents:
監視フォルダーにコピーされるファイルのファイル名と一致するパターンを指定します。名前がパターンと一致するファイルが、入力変数の値として使用されます。例えば、 *.pdf という値を指定すると、PDF ファイルが入力として使用されます。パターンは、複数の添付ファイルを異なる入力変数にマップする必要がある場合に役立ちます。例えば、プロセスが PDF ファイルと DDX ファイルを入力として要求するとします。入力変数の値には *.pdf および *.ddx というパターンが使用されます。
注意: 複雑な変数型と、ドキュメント値を含まないリスト値またはマップ値は、「Input」領域に表示されません。これらの変数型には値を指定できません。

出力

出力変数の値を指定します。変数の型によって、値の表現方法が決まります。

Document variables:
プロセスが返すファイルに名前を付ける方法を指定します。プロセスが document 値を出力として指定した場合、それらはファイルに変換され、結果フォルダーに保存されます。プロセスがドキュメントのリストまたはマップを返す場合、各ドキュメントは変換されます。

添付されたファイルに名前を付けるには、リテラルテキストを含めること、返される document 値の属性を使用すること、またはその両方を行うことができます。

  • リテラルテキストを使用して、すべてのプロセスインスタンスのすべての添付ファイルに同じ名前を使用します。例えば、値 output.pdf を指定すると、すべての添付ファイルの名前が output.pdf になります。

  • 返される document 値の属性を使用して、 document 値の作成元のファイルの名前に基づいて、返されるファイルに名前を付けます。

    • %F: ファイルの名前(ファイル名拡張子は含みません)

    • %E: ファイル名拡張子

    ドキュメント属性は、ドキュメントがファイルから作成されるときに割り当てられる値です。ファイルは、ファイルシステム、URL または電子メール添付ファイルから取得できます。 document 値の属性は、元のファイル名に基づきます。

    多くの場合、プロセスはドキュメントを入力として受け取り、ドキュメントを操作して、そのドキュメントを出力として返します。例えば、監視フォルダーにコピーされるファイルが入力値として使用され、パターン %F.%E が出力ファイル名として使用されるとします。返されるファイルの名前は、入力ファイルと同じ名前になります。

    出力 document 値の属性に値がない場合、%F および %E 文字があるとサーバーでエラーが発生します。プロセスが完了時に電子メールを返さない場合は、サーバーログでエラーメッセージを確認してください。

  • リテラルテキストと %F および %E 文字を組み合わせて使用できます。

Output プロパティの値によって同じ名前のファイルが生成される場合、AEM forms サーバーはファイル名にインデックス番号を追加します。例えば、プロセスがリスト内の 3 つのドキュメントを返し、Output プロパティは out.pdf であるとします。返されるファイルは、out.pdf、out_1.pdf および out_2.pdf になります。

Simple data types:
文字列、数値ベース型、xml、日時ベース型など、単純データ型の入力値にリテラル値を指定します。例えば、SomeText の文字列値として、 SomeText というテキストを指定します。
注意: 複雑な変数型と、ドキュメント値を含まないリスト値またはマップ値は、「Output」領域に表示されません。これらの変数型には値を指定できません。