创建工作流模型 creating-workflow-models

CAUTION
有关使用经典UI的信息,请参阅 AEM 6.3文档 以供参考。

您创建 工作流模型 定义用户启动工作流时执行的一系列步骤。 您还可以定义模型属性,例如工作流是临时工作流还是使用多个资源。

当用户启动工作流时,将启动一个实例;这是相应的运行时模型,创建于 同步 您所做的更改。

创建新工作流 creating-a-new-workflow

首次创建工作流模型时,它包含:

  • 步骤, 流程开始流程结束.
    这些表示工作流的开始和结束。 这些步骤是必需的,无法编辑/删除。
  • 示例 参与者 已命名的步骤 步骤1.
    此步骤配置为向工作流发起者分配工作项。 编辑或删除此步骤,并根据需要添加步骤。

使用编辑器创建工作流:

  1. 打开 工作流模型 控制台;通过 工具工作流模型 或者,例如: https://localhost:4502/aem/workflow
  2. 选择 创建,则 创建模型.
  3. 添加工作流模型 出现对话框。 输入 标题名称 (可选)在选择 完成.
  4. 新模型列在 工作流模型 控制台。
  5. 选择新工作流,然后使用 编辑 以打开它进行配置
    wf-01
NOTE
如果以编程方式(使用crx包)创建模型,则还可以在中创建子文件夹:
/var/workflow/models
例如,/var/workflow/models/prototypes
然后,此文件夹可用于 管理对该文件夹中模型的访问权限.

编辑工作流 editing-a-workflow

您可以编辑任何现有的工作流模型以:

编辑 默认和/或旧版 (现成)工作流 具有额外的步骤,以确保 安全复制 在进行更改之前摄取。

更新完工作流后,您必须使用 同步生成运行时模型. 请参阅 同步您的工作流 以了解详细信息。

同步工作流 — 生成运行时模型 sync-your-workflow-generate-a-runtime-model

同步 (位于编辑器工具栏的右侧)生成 运行时模型. 运行时模型是用户启动工作流时实际使用的模型。 如果你不想 同步 这样,所做的更改在运行时将不可用。

当您(或任何其他用户)对必须使用的工作流进行更改时 同步 生成运行时模型 — 即使单个对话框(例如,对于步骤)具有自己的保存选项。

当更改与运行时(保存的)模型同步时, 已同步 将显示。

某些步骤具有必填字段和/或内置验证。 如果不满足这些条件,则尝试以下操作时将显示错误 同步 模型。 例如,尚未为定义参与者 参与者 步骤:

wf-21

首次编辑默认或旧版工作流 editing-a-default-or-legacy-workflow-for-the-first-time

当您打开 默认和/或旧模型 进行编辑:

  • 步骤浏览器不可用(左侧)。

  • 有一个 编辑 操作在工具栏(右侧)中可用。

  • 最初,模型及其属性以只读模式显示为:

    • 默认工作流位于 /libs
    • 旧版工作流位于 /etc
      选择 编辑 将:
  • 将工作流副本带入 /conf

  • 使步骤浏览器可用

  • 允许您进行更改

NOTE
请参阅 工作流模型的位置 以了解详细信息。

wf-22

向模型添加步骤 adding-a-step-to-a-model

将步骤添加到模型中以表示要执行的活动 — 每个步骤都会执行特定活动。 标准AEM实例中提供了一组步骤组件。

在编辑模型时,可用步骤会出现在各个组的 步骤浏览器. 例如:

wf-10

NOTE
有关随AEM一起安装的主要步骤组件的信息,请参阅 工作流步骤参考.

要将步骤添加到工作流模型,请执行以下操作:

  1. 打开现有的工作流模型进行编辑。 从 工作流模型 控制台,选择所需的模型,然后 编辑.

  2. 打开步骤浏览器;使用 切换侧面板,该工具栏位于顶部工具栏的最左侧。 在此编辑器中,您可以:

    • 筛选 以了解具体步骤。
    • 使用下拉选择器将选择限制为一组特定的步骤。
    • 选择显示描述图标 wf-stepinfo-icon 以显示有关相应步骤的更多详细信息。

    wf-02

  3. 将相应的步骤拖动到模型中的所需位置。

    例如, 参与者步骤.

    添加到流后,您可以 配置步骤.

    wf-03

  4. 根据需要添加任意数量的步骤或其他更新。

    在运行时,步骤将按照它们在模型中出现的顺序执行。 添加步骤组件后,可将其拖动到模型中的其他位置。

    也可以复制、剪切、粘贴、分组或删除现有步骤;就像使用 页面编辑器。

    也可以使用工具栏选项折叠/展开拆分步骤: wf-collapseexpand-toolbar-icon

  5. 使用确认更改 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

配置工作流步骤 configuring-a-workflow-step

您可以 配置 并使用自定义工作流步骤的行为 步骤属性 对话框。

  1. 打开 步骤属性 对话框,显示以下步骤之一:

    • 单击工作流模型中的* *步骤,然后选择 配置 从组件工具栏中。

    • 双击该步骤。

    note note
    NOTE
    有关随AEM一起安装的主要步骤组件的信息,请参阅 工作流步骤参考.
  2. 配置 步骤属性 根据需要;可用的属性取决于步骤类型,可能还有多个可用选项卡。 例如,缺省值 参与者步骤,在新工作流中显示为 Step 1

    wf-11

  3. 用勾号确认您的更新。

  4. 使用确认更改 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

创建临时工作流 creating-a-transient-workflow

您可以创建 瞬态 工作流模型(在创建模型或编辑现有模型时):

  1. 打开的工作流模型 编辑.

  2. 选择 工作流模型属性 工具栏中。

  3. 在对话框中,激活 瞬态工作流 (如有必要,请取消激活):

    wf-07

  4. 确认更改,方法: 保存并关闭;后跟 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

NOTE
在中运行工作流时 瞬态 模式AEM不存储任何工作流历史记录。 因此, 时间线 不显示与该工作流相关的任何信息。

在触屏UI中提供工作流模型 classic2touchui

如果经典UI中存在工作流模型,但在的选择弹出菜单中缺少该模型, 时间线 然后,按照配置使其可用。 以下步骤说明了如何使用名为的工作流模型 请求激活.

  1. 确认模型在触屏UI中不可用。 使用访问资源 /assets.html/content/dam 路径。 选择资源。 打开 时间线 在左边栏中。 单击 启动工作流 并确认 请求激活 弹出列表中不存在模型。

  2. 导航至 “工具”>“常规”>“标记”. 选择 工作流.

  3. 选择 “创建”>“创建标记”. 设置 标题 作为 DAM名称 作为 dam. 选择​ 提交
    在工作流模型中创建标记

  4. 导航到 “工具”>“工作流”>“模型”. 选择 请求激活,然后选择 编辑.

  5. 选择 编辑,打开 页面信息 菜单,然后从中选择 打开属性 然后转到 基本 选项卡(如果尚未打开)。

  6. 添加 Workflow : DAM标记 字段。 使用复选框(勾号)确认选择。

  7. 通过确认添加标记 保存并关闭.
    编辑模型的页面属性

  8. 使用完成此过程 同步. 现在,该工作流在触屏UI中可用。

为多资源支持配置工作流 configuring-a-workflow-for-multi-resource-support

您可以为配置工作流模型 多资源支持 创建模型或编辑现有模型时:

  1. 打开的工作流模型 编辑.

  2. 选择 工作流模型属性 工具栏中。

  3. 在对话框中,激活 多资源支持 (如有必要,请取消激活):

    wf-08

  4. 确认更改,方法: 保存并关闭;后跟 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

配置工作流暂存(显示工作流进度) configuring-workflow-stages-that-show-workflow-progress

工作流暂存 帮助可视化处理任务时工作流的进度。

CAUTION
如果工作流暂存在中定义 页面属性,但不用于任何工作流步骤,则进度栏不会显示任何进度(无论当前工作流步骤是什么)。

可用的阶段在工作流模型中定义;现有工作流模型可以更新以包括阶段定义。 您可以为工作流模型定义任意数量的阶段。

要定义 暂存 对于工作流:

  1. 打开工作流模型进行编辑。

  2. 选择 工作流模型属性 工具栏中。 然后打开 暂存 选项卡。

  3. 添加所需的(和职位) 暂存. 您可以为工作流模型定义任意数量的阶段。

    例如:

    wf-08-1

  4. 单击 保存并关闭 以保存属性。

  5. 为工作流模型中的每个步骤分配一个阶段。 例如:

    wf-09

    一个阶段可以分配给多个步骤。 例如:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    步骤 Stage
    步骤 1 创建
    步骤 2 创建
    步骤 3 审核
    步骤 4 批准
    步骤 5 批准
    步骤 6 完成
  6. 使用确认更改 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

在资源包中导出工作流模型 exporting-a-workflow-model-in-a-package

要导出资源包中的工作流模型,请执行以下操作:

  1. 使用创建包 包管理器

    1. 导航到包管理器,方法为 工具部署.

    2. 单击 创建包.

    3. 指定 包名称,并根据需要提供任何其他详细信息。

    4. 单击​ 确定

  2. 单击 编辑 工具栏上。

  3. 打开 过滤器 选项卡。

  4. 选择 添加筛选器 并指定工作流模型的路径 设计

    /conf/global/settings/workflow/models/<*your-model-name*>

    单击​ 完成

  5. 选择 添加筛选器 并指定 运行时 工作流模型:

    /var/workflow/models/<*your-model-name*>

    单击​ 完成

  6. 为模型使用的任何自定义脚本添加其他筛选器。

  7. 单击 保存 以确认您的筛选器定义。

  8. 选择 生成 从包定义的工具栏中。

  9. 选择 下载 包工具栏中的。

使用工作流处理表单提交 using-workflows-to-process-form-submissions

您可以配置要由所选工作流处理的表单。 当用户提交表单时,将创建一个新的工作流实例,该实例使用表单提交的数据作为其有效负载。

要配置要与表单一起使用的工作流,请执行以下操作:

  1. 创建页面并打开它以进行编辑。

  2. 添加 表单 组件添加到页面。

  3. 配置表单开始 显示在页面中的组件。

  4. 使用 启动工作流 要从可用的工作流中选择所需的工作流,请执行以下操作:

    wf-12

  5. 单击勾号确认新表单配置。

测试工作流 testing-workflows

测试工作流时,好的做法是使用各种有效负载类型(包括与为其开发该工作流的类型不同的类型)。 例如,如果您打算让工作流处理资产,请通过将页面设置为有效负载来测试该工作流,并确保它不会引发错误。

例如,按如下方式测试新工作流:

  1. 启动工作流模型 从控制台中。

  2. 定义 有效负荷 并确认。

  3. 根据需要执行操作,以便工作流继续运行。

  4. 在工作流运行时监视日志文件。

您还可以配置要显示的AEM 调试 日志文件中的消息。 请参阅 记录 当开发完成后,如需进一步资讯及了解详情,请将 日志级别 返回至 信息.

示例 examples

示例:创建一个(简单)工作流以接受或拒绝发布请求 example-creating-a-simple-workflow-to-accept-or-reject-a-request-for-publication

为了说明创建工作流的一些可能性,以下示例创建了 Publish Example 工作流。

  1. 创建工作流模型.

    新工作流将包含:

    • 流程开始
    • Step 1
    • 流程结束
  2. 删除 Step 1 (因为对于本示例来说,它是错误的步骤类型):

    • 单击该步骤并选择 删除 从组件工具栏中。 确认该操作。
  3. 工作流 选择步骤浏览器,拖动 参与者步骤 放到工作流上并将其放置在 流程开始流程结束.

  4. 要打开“属性”对话框,请执行以下操作:

    • 单击参与者步骤并选择 配置 从组件工具栏中。
    • 双击参与者步骤。
  5. 公共 按Tab Enter Validate Content 对于 标题描述.

  6. 打开 用户/组 选项卡:

    • 激活 通过电子邮件通知用户.
    • 选择 Administrator ( admin) 用户/组 字段。
    note note
    NOTE
    对于要发送的电子邮件, 需要配置邮件服务和用户帐户详细信息.
  7. 单击勾号确认更新。

    您将返回到工作流模型的概述,此处参与者步骤将重命名为 Validate Content.

  8. 拖动 或拆分 放到工作流上并将其放置在 Validate Content流程结束.

  9. 打开 或拆分 进行配置。

  10. 配置:

    • 公共:指定拆分名称。

    • 分支1:选择 默认路由.

    • 分支2:确保 默认路由 未选中。

  11. 确认对的更新 OR拆分.

  12. 拖动 参与者步骤 打开左侧的属性,指定以下值,然后确认更改:

    • 标题Reject Publish Request

    • 用户/组:例如, projects-administrators

    • 通过电子邮件通知用户:激活以通过电子邮件通知用户。

  13. 拖动 流程步骤 在右侧分支中,打开属性,指定以下值,然后确认更改:

    • 标题Publish Page as Requested

    • 进程:选择 Activate Page. 此进程将所选页面发布到发布服务器实例。

  14. 单击 同步 (编辑器工具栏)以生成运行时模型。

    请参阅 同步您的工作流 以了解详细信息。

    您的新工作流模型将如下所示:

    wf-13

  15. 将此工作流应用于您的页面,以便当用户移动到 完成验证内容 步骤,用户可以选择是否要 根据请求发布页面,或 拒绝发布请求.

    chlimage_1-72

示例:使用ECMA脚本为OR拆分定义规则 defineruleecmascript

OR拆分 步骤允许您将条件处理路径引入工作流。

要定义OR规则,请按照以下步骤操作:

  1. 创建两个脚本并将它们保存在存储库中,例如,位于以下位置:

    /apps/myapp/workflow/scripts

    note note
    NOTE
    脚本必须具有 函数 check() 返回布尔值。
  2. 编辑工作流并添加 OR拆分 到模型。

  3. 编辑的属性 分支1OR拆分

    • 将此定义为 默认路由 通过设置 true.

    • 作为 规则,设置脚本的路径。 例如:

      /apps/myapp/workflow/scripts/myscript1.ecma

    note note
    NOTE
    您可以根据需要切换分支顺序。
  4. 编辑的属性 分支2OR拆分.

    • 作为 规则,设置其他脚本的路径。 例如:

      /apps/myapp/workflow/scripts/myscript2.ecma

  5. 设置每个分支中各个步骤的属性。 确保 用户/组 设置。

  6. 单击 同步 (编辑器工具栏)来保留对运行时模型所做的更改。

    请参阅 同步您的工作流 以了解详细信息。

函数Check() function-check

NOTE
请参阅 使用ECMAScript.

以下示例脚本返回 true 如果节点为 JCR_PATH 位于 /content/we-retail/us/en

function check() {
    if (workflowData.getPayloadType() == "JCR_PATH") {
      var path = workflowData.getPayload().toString();
      var node = jcrSession.getItem(path);

      if (node.getPath().indexOf("/content/we-retail/us/en") >= 0) {
       return true;
      } else {
       return false;
      }
     } else {
      return false;
     }
}

示例:自定义激活请求 example-customized-request-for-activation

您可以自定义任何现成的工作流。 要具有自定义行为,请叠加相应工作流的详细信息。

例如, 请求激活. 此工作流用于发布中的页面 站点 当内容作者没有相应的复制权限时,将自动触发和。 请参阅 自定义页面创作 — 自定义激活请求工作流 以了解更多详细信息。

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2