工作流最佳实践

通过工作流，您可以自动化Adobe Experience Manager (AEM)活动。

它们通常表示在AEM环境中发生的大量处理，因此，当自定义工作流步骤未根据最佳实践编写时，或者未将现成工作流配置为尽可能高效地运行时，系统可能会受到影响。

因此，强烈建议仔细规划工作流实施。

配置

在配置工作流进程（自定义和/或现成）时，需要牢记以下几点。

瞬态工作流

要优化高摄取负载，您可以定义作为瞬态的工作流.

当工作流是瞬态时，与中间工作步骤相关的运行时数据在运行时不会保留在JCR中（当然，输出演绎版会保留）。

其优势可以包括：

工作流处理时间减少；最多减少10%。
显着减少存储库增长。
不再需要清除CRUD工作流。
此外，它还减少了TAR文件的数量，使其紧凑。

注意

如果您的业务要求您保留/存档工作流运行时数据以进行审核，请勿启用此功能。

调整DAM工作流

有关DAM工作流的性能优化准则，请参阅 AEM Assets Performance Tuning指南.

配置最大并发工作流数

AEM允许同时运行多个工作流线程。默认情况下，线程数配置为系统处理器内核数的一半。

如果正在执行的工作流需要系统资源，这可能意味着AEM几乎无法用于其他任务，例如渲染创作UI。因此，系统在批量图像上传等活动期间可能会变得缓慢。

要解决此问题，Adobe建议将 最大并行作业数 处理器内核数量的一半到四分之三之间。这应允许系统有足够容量在处理这些工作流时保持响应状态。

配置 最大并行作业数，您可以：

配置 OSGi配置 从AEM Web控制台；对于 队列： Granite工作流队列 (一 Apache Sling作业队列配置)。
配置队列可以从 Sling作业 AEM Web控制台的选项； 作业队列配置： Granite工作流队列，位于 http://localhost:4502/system/console/slingevent.

此外，还有一个单独的配置 Granite工作流外部进程作业队列. 这用于启动外部二进制文件的工作流进程，例如 InDesign Server 或 Magick图像.

配置单个作业队列

在某些情况下，配置单个作业队列来控制并发线程或基于单个作业的其他队列选项很有用。您可以通过，从Web控制台添加和配置单个队列。 Apache Sling作业队列配置 工厂。要查找要列出的相应主题，请执行工作流模型并在中查找它 Sling作业 控制台；例如，在 http://localhost:4502/system/console/slingevent.

也可以为临时工作流添加单个作业队列。

配置工作流清除

在标准安装中，AEM提供了一个维护控制台，可以在其中计划和配置每日和每周维护活动；例如，位于：

http://localhost:4502/libs/granite/operations/content/maintenance.html

默认情况下， 每周维护时段 具有 工作流清除 任务，但需要在运行之前对其进行配置。要配置工作流清除，需要使用 AdobeGranite工作流清除配置 必须添加到Web控制台中。

有关AEM中维护任务的更多详细信息，请参阅操作功能板.

自定义

在编写自定义工作流进程时，有一些事项需要牢记。

位置

工作流模型、启动器、脚本和通知的定义根据类型保存在存储库中；即现成、自定义等。

注意

另请参阅 AEM 6.5中的存储库重组.

位置 — 工作流模型

工作流模型根据类型存储在存储库中：

现成的工作流设计保存在以下路径下：

/libs/settings/workflow/models/
注意
请勿：
- 将您的任何自定义工作流模型放置在此文件夹中
- 编辑中的任何内容 /libs
因为任何更改都可能在升级或安装修补程序、累积修补程序包或Service Pack时被覆盖。
自定义工作流设计位于以下位置：
```
/conf/global/settings/workflow/models/...
```
运行时工作流设计（现成工作流设计和自定义工作流设计）保存在以下路径下：

/var/workflow/models/
旧版工作流设计（设计时和运行时）保存在以下路径下：

/etc/workflow/models/

注意

如果编辑了这些设计 使用AEM UI，则详细信息将会复制到新位置。

位置 — 工作流启动器

工作流启动器定义还根据类型存储在存储库中：

现成的工作流启动器位于以下路径下：

/libs/settings/workflow/launcher/
注意
请勿：
- 将您的任何自定义工作流启动器放置在此文件夹中
- 编辑中的任何内容 /libs
因为任何更改都可能在升级或安装修补程序、累积修补程序包或Service Pack时被覆盖。
自定义工作流启动器位于以下位置：
```
/conf/global/settings/workflow/launcher/...
```
旧版工作流启动器位于以下路径下：

/etc/workflow/launcher/

注意

如果编辑了这些定义 使用AEM UI，则详细信息将会复制到新位置。

位置 — 工作流脚本

工作流脚本还根据类型存储在存储库中：

现成的工作流脚本保存在以下路径下：

/libs/workflow/scripts/
注意
请勿：
- 将您的任何自定义工作流脚本放在此文件夹中
- 编辑中的任何内容 /libs
因为任何更改都可能在升级或安装修补程序、累积修补程序包或Service Pack时被覆盖。
自定义工作流脚本位于以下位置：
```
/apps/workflow/scripts/...
```
旧版工作流脚本位于以下路径下：

/etc/workflow/scripts/

位置 — 工作流通知

工作流通知还根据类型存储在存储库中：

现成的工作流通知定义保存在以下路径下：

/libs/settings/workflow/notification/
注意
请勿：
- 将您的任何自定义工作流通知定义放在此文件夹中
- 编辑中的任何内容 /libs
因为任何更改都可能在升级或安装修补程序、累积修补程序包或Service Pack时被覆盖。
自定义工作流通知定义位于下：
```
/conf/global/settings/workflow/notification/...
```
注意

如果要覆盖工作流通知文本，请在以下位置创建一个覆盖的路径：

/conf/global/settings/workflow/notification/<path-under-libs>
旧版工作流通知定义保存在以下路径下：

/etc/workflow/notification/

进程会话

与任何自定义开发一样，始终建议尽可能使用用户会话：

以最佳方式遵守安全准则
允许系统管理会话的打开和关闭

实施工作流进程时：

将提供工作流会话，除非有令人信服的理由不提供该会话，否则应使用该会话。
不应通过工作流步骤创建新会话，因为这会导致状态不一致，并且工作流引擎中可能存在并发问题。
您不应从工作流中的流程步骤中获取新的JCR会话；您应使流程步骤API提供的工作流会话适应JCR会话。例如：

public void execute(WorkItem item, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException {
        // to obtain a jcr session:
        javax.jcr.Session jcrSession = workflowSession.adaptTo(javax.jcr.Session.class);

        // to obtain a sling resource resolver:
        org.apache.sling.api.resource.ResourceResolver slingResourceResolver = workflowSession.adaptTo(org.apache.sling.api.resource.ResourceResolver.class);

保存会话：

在工作流进程内，如果 WorkflowSession 正用于修改存储库，因此不要显式保存会话 — 工作流完成时将保存会话。
Session.Save 不应从工作流步骤中调用：
- 建议调整工作流jcr会话； save 没有必要这样做，因为工作流引擎会在工作流完成执行后自动保存会话。
- 不建议流程步骤创建自己的jcr会话。
通过消除不必要的保存，您可以减少开销，从而提高工作流效率。

注意

尽管有这些建议，但如果您确实创建了自己的jcr会话，则需要保存它。

最大程度地减少启动器的数量/范围

有一个监听器负责所有工作流启动器注册的：

它会侦听其他启动器的通配属性中指定的所有路径的更改。
发送事件后，工作流引擎将评估每个启动器，以确定它是否应运行。

创建过多启动器将导致评估过程运行速度变慢。

在单个启动器上的存储库根目录下创建全局连接路径，会导致工作流引擎侦听并评估存储库中每个节点的创建/修改事件。因此，建议仅创建所需的启动器，并尽可能指定全局连接路径。

由于这些启动器对工作流行为的影响，禁用任何未使用的现成启动器也会很有帮助。

启动器的配置增强

自定义启动器配置已得到增强，可支持以下内容：

同时使用多个条件“AND”。
在单个条件中具有OR条件。
根据功能标志是启用还是禁用，禁用/启用启动器。
在启动器条件中支持正则表达式。

不要从其他工作流启动工作流

工作流可能会产生大量开销，包括在内存中创建的对象和存储库中跟踪的节点两方面都是如此。因此，最好让工作流在自身中进行处理，而不是启动其他工作流。

例如，某个工作流先对一组内容实施业务流程，然后激活该内容。最好创建一个自定义工作流进程来激活其中的每个节点，而不是启动 激活内容 需要发布的每个内容节点的模型。此方法将需要额外的开发工作，但在执行时比为每个激活启动单独的工作流实例更有效。

另一个示例是工作流，该工作流处理多个节点，创建工作流包，然后激活所述包。您无需创建资源包，然后启动一个将资源包作为有效负载的单独工作流，您可以在创建资源包的步骤中更改工作流的有效负载，然后调用步骤以在同一工作流模型中激活资源包。

处理程序前进

在设计工作流模型时，您可以选择在工作流步骤中启用高级处理程序。或者，您也可以将代码添加到工作流步骤，以确定接下来应该运行哪个步骤，然后执行它。

建议使用处理程序前进，因为它可提供更好的性能。

工作流暂存

您可以定义工作流暂存，然后将任务/步骤分配给特定工作流暂存。

此信息用于在单击 工作流信息 选项卡中的工作项 收件箱. 可以编辑现有工作流模型以添加暂存。

激活页面流程步骤

此 激活页面进程 步骤将为您激活页面，但不会自动查找任何引用的DAM资产并激活这些资产。

如果您计划将此步骤用作工作流模型的一部分，请记住这一点。

升级注意事项

升级实例时：

确保在升级实例之前备份任何自定义工作流模型。
确认您的自定义工作流均未存储在位置：
- /libs/settings/workflow/models/projects

注意

另请参阅 AEM 6.5中的存储库重组.

系统工具

有许多系统工具可以帮助监控、维护和故障排除工作流。以下所有示例URL都使用 localhost:4502，但应在任何创作实例上可用( <hostname>:<port>)。

Sling作业处理控制台

http://localhost:4502/system/console/slingevent

Sling作业处理控制台将显示：

自上次重新启动以来系统中作业状态的统计信息。
它还将显示所有作业队列的配置，并提供在配置管理器中编辑它们的快捷方式。

工作流报告工具

将在6.3中删除工作流报告工具，以防止性能下降。

工作流维护操作MBean

http://localhost:4502/system/console/jmx/com.adobe.granite.workflow:type=Maintenance

工作流维护MBean公开了几个有用的维护例程，例如清除已完成的工作流和检索工作流统计信息。