配置监视文件夹端点 configuring-watched-folder-endpoints

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

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

在配置监视文件夹端点之前，请配置监视文件夹服务。 监视文件夹服务的配置参数有两个用途：

配置“监视文件夹”服务后，可以为目标服务添加“监视文件夹”端点。 添加端点时，可设置值，如将文件或文件夹放置在配置的监视文件夹服务的输入文件夹中时要调用的服务名称和操作名称。 有关配置已监视文件夹服务的详细信息，请参阅 监视的文件夹服务设置.

创建监视文件夹 creating-a-watched-folder

您可以通过以下两种方式创建已监视的文件夹：

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

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

已监视文件夹链接在一起 chaining-together-watched-folders

监视文件夹可以链接在一起，以便一个监视文件夹的结果文档是下一个监视文件夹的输入文档。 每个已监视文件夹都可以调用其他服务。 通过以这种方式配置受监视的文件夹，可以调用多项服务。 例如，一个受监视文件夹可以将PDF文件转换为Adobe PostScript®，而另一个受监视文件夹可将PostScript文件转换为PDF/A格式。 要执行此操作，只需将 结果 由您的第一个端点定义的监视文件夹的文件夹，以指向 输入 第二个端点定义的监视文件夹的文件夹。

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

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

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

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

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

监视的文件夹输出 watched-folder-output

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

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

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

监视文件夹的工作方式 how-watched-folder-works

监视文件夹模块包含以下服务：

除了上面列出的服务外，“监视文件夹”还依赖于其他服务，包括调度作业的调度程序服务和支持目标服务异步调用的作业管理器服务。

监视文件夹如何处理调用请求 how-watched-folder-processes-an-invocation-request

监视文件夹服务可处理端点的创建、更新和删除。 管理员创建端点后，将根据指定的重复间隔或cron表达式，安排由调度程序服务触发这些端点。

此图说明了“监视文件夹”如何处理调用请求。

使用已监视文件夹调用服务的过程如下所示：

监视文件夹端点设置 watched-folder-endpoint-settings

使用以下设置配置监视文件夹端点。

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

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

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

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

Cron表达式： 如果必须使用cron表达式计划监视的文件夹，请输入cron表达式。 配置此设置后，将忽略重复间隔。

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

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

限制： 选择此选项后，将限制AEM表单在任何给定时间处理的已监视文件夹作业的数量。 最大作业数由批量大小值确定。 （请参阅关于限制。）

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

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

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

“重复间隔”和“批量大小”设置可确定“监视文件夹”在每次扫描中接收的文件数。 监视文件夹使用石英线程池扫描输入文件夹。 线程池与其他服务共享。 如果扫描间隔较小，线程将经常扫描输入文件夹。 如果文件经常被放入监视文件夹，则扫描间隔应保持较小。 如果文件不常被删除，请使用较大的扫描间隔，以便其他服务可以使用线程。

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

将文件放入监视文件夹后，会在输入中列出文件，如果每秒进行扫描，会降低性能。 增加扫描间隔可以提高性能。 如果要删除的文件量较小，请相应地调整批量大小和重复间隔。 例如，如果每秒删除10个文件，请尝试将“重复间隔”设置为1秒，将“批处理大小”设置为10。

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

此设置有助于确保文件或文件夹已完全复制到输入文件夹。 例如，如果要处理大文件，并且文件需要10分钟才能下载，请将等待时间设置为10*60 *1000毫秒。 如果文件未保持10分钟，则阻止监视文件夹扫描文件。

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

当输入的文件夹包含多个文件时，此设置非常有用。 文件夹的内容可以复制到一个文件夹中，该文件夹的名称将由监视的文件夹选取。 这样可防止监视文件夹在将文件夹完全复制到输入文件夹之前提取文件夹进行处理。

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

有关文件模式的更多信息，请参阅 关于文件模式.

包含文件模式： （必填）分号 ; 已监视文件夹用来确定要扫描和选取的文件夹和文件的模式的分隔列表。 例如，如果“Include File Pattern（包含文件模式）”为input*，则所有与input&ast（输入和发送）匹配的文件和文件夹；被接走。 这包括名为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/，这是监视文件夹内的Result文件夹。 有关文件模式的更多信息，请参阅 关于文件模式.

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

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

只读文件不会进行处理，并将保存在失败文件夹中。

默认值为failure/%Y/%M/%D/。

失败时保留： 在无法对服务执行操作时保留输入文件。 默认值为true。

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

清除持续时间： （必需）结果文件夹中的文件和文件夹如果比此值旧，则会清除它们。 此值以天为单位。 此设置有助于确保结果文件夹不会变满。

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

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

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

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

变量： 输入的值是已监视文件夹用来选取输入的文件模式。 例如，在加密密码服务(输入文档必须是PDF文件)中，用户可以使用*.pdf作为文件模式。 监视文件夹将选取与此模式匹配的监视文件夹中的所有文件，并为每个文件调用服务。 使用变量时，所有输入文件都将转换为文档。 仅支持使用文档作为输入类型的API。

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

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

关于文件模式 about-file-patterns

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

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

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

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

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

关于限制 about-throttling

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

节流的工作原理 how-throttling-works

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

限制会阻止监视文件夹在前一个作业未完成时调用新作业。 已监视文件夹将检测正在进行的作业，并根据批处理大小减去正在进行的作业来处理新作业。 例如，在第二次调用中，如果已完成的作业数仅为三个，并且一个作业仍在进行中，则“监视文件夹”仅会再调用三个作业。

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

监视文件夹可在一个节点上共提供100个文件夹。 “已监视文件夹”的性能取决于表单服务器的性能。 对于异步调用，性能更取决于作业管理器队列中的系统负载和作业。

通过向群集中添加节点，可以提高监视文件夹的性能。 监视的文件夹作业通过Quartz调度程序和作业管理器服务在异步请求时跨群集节点进行分发。 所有作业都将保留在数据库中。

监视的文件夹取决于调度程序服务来调度、取消调度和重新计划作业。 其他服务（如事件管理服务、用户管理器服务和电子邮件提供程序服务）可共享调度程序服务线程池。 这会影响“已监视文件夹”的性能。 当所有服务开始使用调度程序服务线程池时，将需要调度程序服务线程池调整。

已监视群集中的文件夹 watched-folders-in-a-cluster

在群集中，“监视文件夹”取决于Quartz调度程序和作业管理器服务，以进行负载平衡和故障转移。 有关Quartz群集行为的详细信息，请参阅 石英文献.

监视文件夹在每次投票时执行以下三项主要任务：

负载平衡和故障转移行为会根据监视文件夹是配置为同步调用还是异步调用而发生更改。

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

为了进行同步调用，Quartz负载平衡器将决定哪个节点将获得轮询事件。 获取轮询事件的节点将执行所有任务：扫描文件夹、调用target服务并处理结果。

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

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

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

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

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

在每个轮询事件中，“监视文件夹”会锁定输入文件夹，将与包含文件模式匹配的文件移动到暂存文件夹，然后解锁输入文件夹。 需要锁定，以便两个线程不会选取同一组文件并处理它们两次。 如果重复间隔较小且批量较大，则发生这种情况的可能性会增加。 将文件移到暂存文件夹后，将解锁输入文件夹，以便其他线程可以扫描该文件夹。 此步骤有助于提供高吞吐量，因为在一个线程处理文件时，其他线程可以扫描。

将文件移到暂存文件夹后，将为每个文件创建调用请求并调用目标服务。 有时，监视文件夹无法恢复暂存文件夹中的文件：

同步： 如果“已监视文件夹”配置为同步调用服务，则暂存文件夹中的所有文件在暂存文件夹中都将保留未处理。

异步： 在这种情况下，“已监视文件夹”依赖于作业管理器服务。 如果作业管理器服务调用回监视文件夹，则根据调用结果将暂存文件夹中的文件移动到保留或失败文件夹中。 如果作业管理器服务未回调“已监视文件夹”，则这些文件将在暂存文件夹中保持未处理状态。 当作业管理器回调时，监视文件夹未运行时，会发生这种情况。

恢复暂存文件夹中未处理的源文件 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表单服务器可处理的作业速率。 实际使用的参数可能因配置的监视文件夹数量、使用监视文件夹的服务以及处理器上作业的密集程度而异。

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

条形码表单服务建议 barcoded-forms-service-recommendations