配置观察文件夹端点 configuring-watched-folder-endpoints

管理员可以配置网络文件夹，称为 观察文件夹，以便当用户将文件(如PDF文件)放入watched文件夹时，将调用配置的服务操作并操作该文件。 服务执行指定的操作后，将修改的文件保存在指定的输出文件夹中。

配置Watched文件夹服务 configuring-the-watched-folder-service

在配置Watched文件夹端点之前，请配置Watched文件夹服务。 观察文件夹服务的配置参数有两个目的：

在配置Watched文件夹服务后，您为目标服务添加一个Watched文件夹端点。 添加端点时，可以设置值，例如将文件或文件夹放在配置的Watched Folder服务的输入文件夹中时要调用的服务名称和操作名称。 有关配置Watched Folder服务的详细信息，请参见 观察文件夹服务设置.

正在创建watched文件夹 creating-a-watched-folder

您可以通过以下两种方式创建观察文件夹：

在群集环境中，用作观察文件夹的文件夹必须在文件系统或网络上可访问、可写和共享。 在此方案中，群集的每个应用程序服务器实例都必须具有对同一共享文件夹的访问权限。

在Windows中，如果应用程序服务器作为服务运行，则必须通过以下方式之一以对共享文件夹的适当访问权限启动该服务器：

将受监视的文件夹链接在一起 chaining-together-watched-folders

可以将观察文件夹链接在一起，以便一个观察文件夹的结果文档是下一个观察文件夹的输入文档。 每个观察文件夹都可以调用不同的服务。 通过以这种方式配置watched文件夹，可以调用多个服务。 例如，一个观察文件夹可以将PDF文件转换为Adobe PostScript®而另一个观察文件夹可以将PostScript文件转换为PDF/A格式。 要实现此目的，只需设置 结果 您第一个端点定义的watched文件夹的文件夹指向 输入 您第二个端点定义的观察文件夹的文件夹。

第一次转换的输出将转到\path\result。 第二次转换的输入是\path\result，第二次转换的输出将转到\path\result\result （或您在第二次转换的结果文件夹框中定义的目录）。

用户如何与watched文件夹交互 how-users-interact-with-watched-folders

对于watched文件夹端点，用户可以通过将输入文件或文件夹从其桌面复制或拖动到watched文件夹来进行调用。 文件将按其到达的顺序进行处理。

对于观察文件夹端点，如果作业只需要一个输入文件，则用户可以将该文件复制到观察文件夹的根目录。

如果作业包含多个输入文件，则用户必须在监视文件夹层次结构之外创建一个包含所有必需文件的文件夹。 此新文件夹应包含输入文件（如果进程需要，还可以选择包含DDX文件）。 构造作业文件夹后，用户将其复制到观察文件夹的输入文件夹中。

观察文件夹输出 watched-folder-output

当输入是一个文件夹并且输出由多个文件组成时，AEM forms会创建一个与输入文件夹同名的输出文件夹，并将输出文件复制到该文件夹中。 当输出包含包含键值对的文档映射（如输出进程的输出）时，将使用该键作为输出文件名。

终结点进程产生的输出文件名不能包含字母、数字和句点(.)以外的字符 文件扩展名之前。 AEM表单将其他字符转换为十六进制值。

客户端应用程序从watched文件夹结果文件夹中选取结果文档。 进程错误记录在watched文件夹失败文件夹中。

观察文件夹的工作方式 how-watched-folder-works

Watched Folder模块包含以下服务：

除了上面列出的服务之外， Watched Folder还依赖于其他服务，包括用于调度作业的调度程序服务和支持目标服务的异步调用的作业管理器服务。

观察文件夹处理调用请求的方式 how-watched-folder-processes-an-invocation-request

Watched Folder服务处理端点的创建、更新和删除。 管理员创建端点后，调度程序服务会根据指定的重复间隔或cron表达式触发这些端点。

此图说明了Watched文件夹如何处理调用请求。

使用watched文件夹调用服务的过程如下：

观察文件夹终结点设置 watched-folder-endpoint-settings

使用以下设置配置观察文件夹端点。

名称： （必需）标识端点。 不要包含<字符，因为它将截断工作区中显示的名称。 如果您输入URL作为端点的名称，请确保它符合RFC1738中指定的语法规则。

描述： 端点的描述。 不要包含<字符，因为它将截断工作区中显示的描述。

路径： （必需）指定watched文件夹位置。 在群集环境中，此设置必须指向可从群集中的每台计算机访问的共享网络文件夹。

异步： 将调用类型标识为异步或同步。 默认值为asynchronous。 建议对长生命周期进程使用异步，对瞬态或短生命周期进程使用同步。

Cron表达式： 如果必须使用cron表达式来安排watched文件夹，请输入cron表达式。 配置此设置时，将忽略“重复间隔”。

重复间隔： 扫描观察文件夹以输入的时间间隔（以秒为单位）。 除非启用“限制”设置，否则“重复间隔”应大于处理平均作业的时间；否则，系统可能会过载。 默认值为 5。有关其他信息，请参阅批量大小的说明。

重复计数： 观察文件夹扫描文件夹或目录的次数。 值–1表示无限扫描。 默认值为 -1。

限制： 如果选择该选项，它会限制AEM在任何给定时间处理受监视文件夹作业的数量。 最大作业数由“批次大小”值决定。 （请参阅关于限制。）

用户名： （必需）从watched文件夹调用目标服务时使用的用户名。 默认值为SuperAdmin。

域名： （必需）用户的域。 默认值为DefaultDom。

批次大小： 每次扫描要提取的文件或文件夹数。 用于防止系统过载；一次扫描太多文件可能会导致崩溃。 默认值为 2。

“重复间隔”和“批次大小”设置确定每次扫描中观察文件夹选取的文件数。 观察文件夹使用Quartz线程池扫描输入文件夹。 线程池与其他服务共享。 如果扫描间隔很小，则线程将经常扫描输入文件夹。 如果文件经常被放入观察文件夹，则应该保持较小的扫描间隔。 如果文件不经常被丢弃，请使用较大的扫描间隔，以便其他服务可以使用线程。

如果正在删除大量文件，请使批次大小变大。 例如，如果监视文件夹端点调用的服务每分钟可以处理700个文件，并且用户以相同的速率将文件放入输入文件夹，则将“批处理大小”设置为350，将“重复间隔”设置为30秒将有助于提高监视文件夹的性能，而不会产生过于频繁地扫描监视文件夹的成本。

当文件被拖放到watched文件夹中时，它会列出输入中的文件，如果每秒都进行扫描，则可能会降低性能。 增加扫描间隔可以提高性能。 如果正在删除的文件量很小，请相应地调整“批次大小”和“重复间隔”。 例如，如果每秒删除10个文件，请尝试将“重复间隔”设置为1秒，并将“批次大小”设置为10。

等待时间： 创建文件夹或文件后等待扫描的时间（以毫秒为单位）。 例如，如果等待时间为3,600,000毫秒（1小时），文件是在一分钟前创建的，则将在59分钟或更长时间后提取此文件。 默认值为 0。

此设置对于确保将文件或文件夹完全复制到输入文件夹非常有用。 例如，如果处理的文件很大，且下载文件需要10分钟，则将等待时间设置为10&ast；60 &ast；1000毫秒。 这样可以防止观察文件夹在文件未满十分钟时扫描文件。

排除文件模式： 分号 ； 观察文件夹用来确定要扫描和选取的文件和文件夹的分隔模式列表。 将不会扫描任何具有此模式的文件或文件夹以进行处理。

当输入是具有多个文件的文件夹时，此设置很有用。 文件夹的内容可以复制到一个名称为的文件夹中，该名称将被监视文件夹提取。 这可以防止观察文件夹在将该文件夹完全复制到输入文件夹之前拾取要处理的文件夹。

您可以使用文件模式来排除：

有关文件模式的详细信息，请参见 关于文件模式.

包含文件模式： （必需）分号 ； 观察文件夹用来确定要扫描和选取的文件夹和文件的模式分隔列表。 例如，如果“包含文件模式”是input&ast；，则选取与input&ast；匹配的所有文件和文件夹。 这包括名为input1、input2等的文件和文件夹。

默认值为&ast；，表示所有文件和文件夹。

您可以使用文件模式来包括：

有关文件模式的详细信息，请参见 关于文件模式.

结果文件夹： 存储所保存结果的文件夹。 如果结果未出现在此文件夹中，请检查失败文件夹。 只读文件不会得到处理，将保存在故障文件夹中。 此值可以是具有以下文件模式的绝对路径或相对路径：

例如，如果是2009年7月17日晚上8点，并且您指定 C:/Test/WF0/failure/%Y/%M/%D/%H/，结果文件夹为 C:/Test/WF0/failure/2009/07/17/20.

如果路径不是绝对路径而是相对路径，则将在观察文件夹内创建该文件夹。 默认值为result/%Y/%M/%D/，它是watched文件夹内的Result文件夹。 有关文件模式的详细信息，请参见 关于文件模式.

保留文件夹： 成功扫描和提取后存储文件的位置。 路径可以是绝对、相对或空目录路径。 您可以使用文件模式，如“结果文件夹”中所述。 默认值为preserve/%Y/%M/%D/。

失败文件夹： 保存失败文件的文件夹。 此位置始终相对于观察文件夹。 您可以使用文件模式，如“结果文件夹”中所述。

只读文件不会得到处理，将保存在故障文件夹中。

默认值为失败/%Y/%M/%D/。

失败时保留： 如果对服务运行操作失败，则保留输入文件。 默认值为true。

覆盖重复的文件名： 当设置为True时，将覆盖结果文件夹和保留文件夹中的文件。 当设置为False时，使用具有数字索引后缀的文件和文件夹作为名称。 默认值为False。

清除持续时间： （必需）当结果文件夹中的文件和文件夹早于此值时会将其清除。 此值以天为单位。 此设置有助于确保结果文件夹不会变满。

值为–1天表示从不删除结果文件夹。 默认值为 -1。

操作名称： （必需）可分配给观察文件夹端点的操作列表。

输入参数映射： 用于配置处理服务和操作所需的输入。 可用的设置取决于使用观察文件夹端点的服务。 以下是两种类型的输入：

文本： 观察文件夹使用在显示的字段中输入的值。 支持所有基本Java类型。 例如，如果API使用字符串、long、int和Boolean等输入，则字符串将转换为正确类型并调用服务。

变量： 输入的值是watched文件夹用来选取输入的文件模式。 例如，如果存在加密密码服务，其中输入文档必须是PDF文件，则用户可以使用&ast；.pdf作为文件模式。 观察文件夹将拾取观察文件夹中与此模式匹配的所有文件，并为每个文件调用服务。 使用变量时，所有输入文件都会转换为文档。 仅支持使用文档作为输入类型的API。

输出参数映射： 用于配置服务和操作的输出。 可用的设置取决于使用观察文件夹端点的服务。

观察文件夹输出可以是单个文档、文档列表或文档地图。 然后，使用“输出参数映射”中指定的模式将这些输出文档保存在结果文件夹中。

关于文件模式 about-file-patterns

管理员可以指定可以调用服务的文件类型。 可以为每个观察文件夹建立多个文件模式。 文件模式可以是以下文件属性之一：

管理员可以定义用于存储结果的输出文件夹的文件模式。 对于输出文件夹（“结果”、“保留”和“失败”），管理员可以指定以下任何文件模式：

例如，结果文件夹的路径可以是 C:\Adobe\Adobe_Experience_Manager_forms\BarcodedForms\%y\%m\%d.

输出参数映射还可以指定其他模式，例如：

如果输出参数映射模式以“File.separator”（路径分隔符）结尾，则会创建一个文件夹，并将内容复制到该文件夹中。 如果模式不以“File.separator”结尾，则会使用该名称创建内容（结果文件或文件夹）。 有关输出参数映射的详细信息，请参见 监视文件夹的提示和技巧.

关于限制 about-throttling

为监视文件夹端点启用限制时，它会限制可在任意给定时间处理的监视文件夹作业的数量。 最大作业数由批处理大小值决定，该值也可以在Watched文件夹端点中配置。 当达到限制限制时，将不会轮询观察文件夹输入目录中的传入文档。 文档还将保留在输入目录中，直到其他观察的文件夹作业完成并再次尝试轮询为止。 如果存在同步处理，则单个轮询中处理的所有作业都将计入限制限制，即使这些作业在单个线程中连续处理也是如此。

限制的工作方式 how-throttling-works

“观察文件夹”在每个重复间隔扫描输入文件夹，选取在“批处理大小”中指定的文件数，并为每个文件调用目标服务。 例如，如果批次大小为4，则每次扫描时，Watched Folder将选取四个文件，创建四个调用请求，并调用目标服务。 在完成这些请求之前，如果调用Watched Folder，则无论前四个作业是否完成，都将再次启动四个作业。

限制功能可防止Watched文件夹在前面的作业未完成时调用新作业。 观察文件夹将检测正在进行的作业，并根据批处理大小减去正在进行的作业来处理新作业。 例如，在第二次调用中，如果完成的作业数只有三个，并且一个作业仍在进行中，则Watched Folder将仅调用另外三个作业。

性能和可扩展性 performance-and-scalability

“观察文件夹”可以在单个节点上提供总计100个文件夹。 Watched文件夹的性能取决于Forms服务器的性能。 对于异步调用，性能更取决于系统负载和作业管理器队列中的作业。

通过向群集添加节点，可以改进观察文件夹的性能。 监视文件夹作业通过Quartz调度程序跨群集节点分发，如果有异步请求，则通过Job Manager服务分发。 所有作业都保留在数据库中。

监视文件夹依赖调度程序服务来计划、取消计划和重新计划作业。 其他服务（如事件管理服务、用户管理器服务和电子邮件提供商服务）共享调度程序服务线程池。 这会影响Watched文件夹性能。 当所有服务都开始使用调度程序服务线程池时，需要对其进行调整。

群集中的观察文件夹 watched-folders-in-a-cluster

在群集中， Watched Folder依赖于Quartz计划程序和Job Manager服务来实现负载平衡和故障转移。 有关Quartz群集行为的详细信息，请参见 Quartz文档.

观察文件夹在每次轮询时执行以下三项主要任务：

负载平衡和故障转移行为会根据是否将观察文件夹配置为同步调用或异步调用而发生更改。

群集中的同步观察文件夹 synchronous-watched-folder-in-a-cluster

对于同步调用，由Quartz负载均衡器决定哪个节点将获得轮询事件。 获取轮询事件的节点将执行所有任务：扫描文件夹、调用目标服务以及处理结果。

对于同步调用，当一个节点失败时，Quartz调度程序会向其他节点发送新的轮询事件。 在失败节点上启动的调用将丢失。 有关如何恢复与失败作业关联的文件的详细信息，请参见 故障点和恢复.

群集中的异步观察文件夹 asynchronous-watched-folder-in-a-cluster

对于异步调用，Quartz负载平衡器决定哪个节点将获得轮询事件。 获取轮询事件的节点将扫描输入文件夹，并通过将请求置于作业管理器服务队列中来调用目标服务。 作业管理器服务负载平衡器依次负责决定哪个节点将处理调用请求。 即使节点A创建了调用请求，节点B最终还是会处理该请求。 或者，启动调用请求的节点可能最终也会处理该请求。

对于异步调用，当一个节点失败时，Quartz计划程序会向其他节点发送新的轮询事件。 在失败节点上创建的调用请求将位于作业管理器服务队列中，并将发送到其他节点进行处理。 未创建调用请求的文件将保留在stage文件夹中。 有关如何恢复与失败作业关联的文件的详细信息，请参见 故障点和恢复.

故障点和恢复 failure-points-and-recovery

在每个轮询事件中， Watched Folder锁定输入文件夹，将匹配包含文件模式的文件移到stage文件夹，然后解除锁定输入文件夹。 需要锁定，这样两个线程就不会拾取同一组文件并对其进行两次处理。 当重复间隔较小且批次较大时，发生此情况的几率会增加。 将文件移到stage文件夹后，输入文件夹将被解锁，以便其他线程可以扫描该文件夹。 此步骤有助于提供高吞吐量，因为其他线程可以在一个线程处理文件时进行扫描。

将文件移到stage文件夹后，将为每个文件创建调用请求，并调用目标服务。 在Watched Folder无法恢复stage文件夹中的文件的情况下：

同步： 如果Watched文件夹配置为同步调用服务，则stage文件夹中的所有文件在stage文件夹中保持未处理状态。

异步： 在这种情况下， Watched文件夹依赖作业管理器服务。 如果作业管理器服务回调Watched文件夹，则根据调用的结果，会将暂存文件夹中的文件移到preserve或failure文件夹。 如果作业管理器服务没有回调“观察文件夹”，则文件在stage文件夹中将保持未处理状态。 当作业管理器回拨时，Watched文件夹未运行，会发生这种情况。

正在恢复stage文件夹中未处理的源文件 recovering-unprocessed-source-files-in-the-stage-folder

当观察文件夹无法处理暂存文件夹中的源文件时，您可以恢复未处理的文件。

观察文件夹的安全注意事项 security-considerations-for-watched-folders

每个观察文件夹都配置了用户名和密码。 调用服务时将使用这些凭据。 监视文件夹依赖于以下事实：共享文件夹受基础安全文件系统的保护，因此只有监视文件夹的所有者才能访问该共享文件夹。

监视文件夹的提示和技巧 tips-and-tricks-for-watched-folders

以下是配置Watched文件夹端点时的一些提示和技巧：

适用于观察文件夹的特定于服务的建议 service-specific-recommendations-for-watched-folders

对于所有服务，您应该调整观察文件夹的批次大小和重复间隔，以便Watched文件夹选取新文件和文件夹进行处理的速率不会超过AEM Forms服务器可以处理的作业速率。 实际使用的参数可能会有所不同，具体取决于配置的观察文件夹数量、使用观察文件夹的服务以及处理器上的作业强度。

生成PDF服务推荐 generate-pdf-service-recommendations

条形码表单服务推荐 barcoded-forms-service-recommendations