工作流最佳实践

工作流使您能够自动执行Adobe Experience Manager(AEM)活动。

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

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

配置

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

瞬态工作流

要优化高摄取负载，您可以将工作流定义为临时。

当工作流为临时工作流时，与中间工作步骤相关的运行时数据在运行时不会在JCR中保留（输出再现当然会保留）。

优势包括：

• 缩短工作流处理时间；10%。
• 显着减少存储库增长。
• 不需要再有CRUD工作流才能清除。
• 此外，它还将TAR文件的数量减少到压缩。

调整DAM工作流

有关DAM工作流的性能调整指南，请参阅《AEM Assets性能调整指南》。

配置并发工作流的最大数

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

如果正在执行的工作流需要系统资源，这可能意味着AEM将几乎不会用于其他任务，如渲染创作UI。 因此，在诸如批量图像上传等活动期间，系统可能处于停滞状态。

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

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

• 从AEM Web控制台配置​OSGi Configuration;对于​队列：Granite工作流队列（Apache Sling作业队列配置）。

• 通过AEM Web控制台的​Sling Jobs​选项配置队列；对于​作业队列配置：Granite工作流队列，位于http://localhost:4502/system/console/slingevent。

此外，还为​Granite工作流外部进程作业队列​提供了单独的配置。 它用于启动外部二进制文件的工作流进程，如​InDesign Server​或​图像Magick。

配置单个作业队列

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

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

配置工作流清除

在标准安装中，AEM提供维护控制台，可在该控制台中安排和配置每日和每周的维护活动;例如，at:

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

默认情况下，每周维护窗口​具有​工作流清除​任务，但在运行前需要配置该窗口。 要配置工作流清除，必须在Web控制台中添加新的​AdobeGranite工作流清除配置。

有关AEM中维护任务的更多详细信息，请参阅操作仪表板。

自定义

编写自定义工作流程时，应牢记一些事情。

位置

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

位置 — 工作流模型

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

• 开箱即用的工作流程设计位于以下路径下：

  /libs/settings/workflow/models/

  注意

  不要：

  • 将您的任何自定义工作流模型放置在此文件夹中
  • 编辑/libs中的任何内容

  由于任何更改可能会在升级时或安装热修复、累积修复包或服务包时被覆盖。

• 自定义工作流设计包含在以下位置：

  /conf/global/settings/workflow/models/...
  

• 运行时工作流设计（现成和自定义）按以下路径进行：

  /var/workflow/models/

• 旧版工作流程设计（设计时和运行时）按以下路径进行：

  /etc/workflow/models/

  注意

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

位置 — 工作流启动器

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

• 开箱即用的工作流启动器按以下路径持有：

  /libs/settings/workflow/launcher/

  注意

  不要：

  • 将任何自定义工作流启动器放置在此文件夹中
  • 编辑/libs中的任何内容

  由于任何更改可能会在升级时或安装热修复、累积修复包或服务包时被覆盖。

• 自定义工作流启动器位于以下位置：

  /conf/global/settings/workflow/launcher/... 
  

• 旧版工作流启动器按以下路径存放：

  /etc/workflow/launcher/

  注意

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

位置 — 工作流脚本

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

• 开箱即用的工作流脚本位于以下路径下：

  /libs/workflow/scripts/

  注意

  不要：

  • 将任何自定义工作流脚本放入此文件夹中
  • 编辑/libs中的任何内容

  由于任何更改可能会在升级时或安装热修复、累积修复包或服务包时被覆盖。

• 自定义工作流脚本保留在以下位置：

  /apps/workflow/scripts/... 
  

• 旧版工作流脚本位于以下路径下：

  /etc/workflow/scripts/

位置 — 工作流通知

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

• 现成的工作流通知定义位于以下路径下：

  /libs/settings/workflow/notification/

  注意

  不要：

  • 将任何自定义工作流通知定义放置在此文件夹中
  • 编辑/libs中的任何内容

  由于任何更改可能会在升级时或安装热修复、累积修复包或服务包时被覆盖。

• 自定义工作流通知定义位于以下位置：

  /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会话。

• 通过消除不必要的节省，您可以减少开销，从而提高工作流的效率。

将启动器数量/范围降至最小

有一个侦听器负责所有已注册的工作流启动器:

• 它将侦听其他启动器的全局属性中指定的所有路径的更改。
• 分派事件时，工作流引擎将评估每个启动器以确定其是否应运行。

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

在单个启动器上在存储库的根位置创建全局事件将导致工作流引擎侦听并评估对存储库中每个节点的创建/修改。 因此，建议仅创建所需的启动器，并尽可能使覆盖路径具体化。

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

启动器的配置增强

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

• 将多个条件“AND”结合在一起。
• 在单个条件中具有OR条件。
• 根据是启用还是禁用功能标志禁用/启用启动器。
• 在启动器条件中支持正则表达式。

不开始其他工作流的工作流

工作流可以带来大量开销，无论是在内存中创建的对象，还是在存储库中跟踪的节点。 因此，最好让工作流在其内部进行处理，而不是开始其他工作流。

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

另一个示例是处理多个节点、创建工作流包、然后激活所述包的工作流。 您可以在创建包的步骤中更改工作流的有效负荷，然后调用该步骤以在同一工作流模型内激活该包，而不是先创建包，然后再以包作为有效负荷启动单独的工作流。

处理程序前进

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

建议使用处理程序高级，因为它提供了更好的性能。

工作流阶段

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

当您单击​收件箱​🔗​中工作项的​工作流信息​选项卡时，此信息用于显示工作流的进度。 可以编辑现有工作流模型以添加阶段。

激活页面处理步骤

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

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

升级注意事项

升级实例时：

• 确保在升级实例之前备份任何自定义工作流模型。

• 确认您的自定义工作流未存储在location下：

  • /libs/settings/workflow/models/projects

系统工具

有许多系统工具可用于帮助监视、维护和排除工作流故障。 以下所有示例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公开了几个有用的维护例程，如清除已完成的工作流和检索工作流统计信息。

更多信息

有关更多信息，请参阅：

• 使用工作流
• 管理工作流
• 开发和扩展工作流
• 性能优化