工作流步骤参考

上次更新： 2023-10-25

主题：
Developing
查看有关此主题的更多信息

创建对象：
Developer

工作流模型由一系列各种类型的步骤组成。根据类型，可以使用参数和脚本配置并扩展这些步骤，以提供所需的功能和控制。

注意

本节介绍标准工作流步骤。

有关特定于模块的步骤，请参阅以下内容：

步骤属性

每个步骤组件都有一个 步骤属性 用于定义和编辑所需属性的对话框。

步骤属性 — 常用选项卡

以下属性的组合可用于位于上的大多数工作流步骤组件公共属性对话框的选项卡：

标题
步骤的标题。
描述
步骤的描述。
工作流暂存

用于应用 Stage 跳到台阶。
超时

步骤“超时”之前的一段时间。
您可以在以下各项之间进行选择：关闭，立即， 1h， 6h， 12h， 24h.
超时处理程序

步骤超时时控制工作流的处理程序。例如，Auto Advancer
处理程序前进

选择此选项可自动将工作流前进到执行后的下一个步骤。如果未选中，则实施脚本必须处理工作流提升。

步骤属性 — 用户/组选项卡

以下属性可用于上的许多工作流步骤组件 用户/组 属性对话框的选项卡：

通过电子邮件通知用户
- 当工作流到达步骤时，您可以通过向参与者发送电子邮件来通知参与者。
- 如果启用，将向属性定义的用户发送电子邮件 用户/组，或者组中的每个成员（如果已定义组）。
用户/组
- 下拉选择框允许您导航到用户或组并选择它们。
- 如果将步骤分配给特定用户，则只有此用户才能执行该步骤。
- 如果将步骤分配给整个组，则当工作流达到此步骤时，该组中的所有用户都会在其 工作流收件箱.
- 请参阅参与工作流以了解更多信息。

AND 拆分

此 AND拆分 在工作流中创建拆分，然后两个分支均处于活动状态。您可以根据需要向每个分支添加工作流步骤。此步骤可让您在工作流中引入多个处理路径。例如，您可以允许并行执行某些审阅步骤，从而节省时间。

wf-26

AND拆分 — 配置

要配置拆分，请执行以下操作：

编辑 AND拆分属性：
- 拆分名称：分配名称以供解释
- 选择所需的分支数；2、3、4或5。
根据需要将工作流步骤添加到分支。

容器步骤

容器步骤会启动另一个作为子工作流执行的工作流模型。

利用此容器，可重复使用工作流模型以实施常见的步骤序列。例如，翻译工作流模型可用于多个编辑工作流。

wf-28

容器步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
容器
- 子工作流：选择要启动的工作流。

跳转步骤

此 跳转步骤 用于指定要在工作流模型中执行的下一步。您可以将规则定义、外部脚本或ECMA脚本指定为路由表达式，以评估工作流模型的下一步。

如果您指定的条件为true，则 跳转步骤 完成，工作流引擎将执行指定的步骤。
如果您指定的条件不成立，则 跳转步骤 完成，而正常的路由逻辑将决定下一个要执行的步骤。

此 跳转步骤 允许您在工作流模型中实施高级路由结构。例如，要实施循环， 跳转步骤 可以定义为在工作流中执行前一个步骤，路由表达式用于评估循环条件。

跳转步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
进程
- Target步骤：选择评估路由表达式的条件后要执行的步骤。
- 路由表达式：选择规则定义、外部脚本或确定是否执行 定位步骤.
  - 规则定义： 使用表达式编辑器以定义规则。
  - 外部脚本： 外部脚本的路径。
  - ECMA脚本：确定是否执行 跳转步骤.

模拟for循环

模拟“for循环”要求您保持已发生的循环迭代次数的计数：

计数通常表示工作流中执行的项目的索引。
计数将作为循环的退出条件评估。

例如，要实施一个在多个JCR节点上执行操作的工作流，您可以使用循环计数器作为节点的索引。若要保留计数，请存储 integer 工作流实例的数据映射中的值。要递增计数并将计数与退出条件进行比较，请使用脚本 跳转步骤.

function check(){
   var count=0;
   var keyname="loopcount"
   try{
      if (workflowData.getMetaDataMap().containsKey(keyname)){
        log.info("goto script: found loopcount key");
        count= parseInt(workflowData.getMetaDataMap().get(keyname))+1;
      }

     workflowData.getMetaDataMap().put(keyname,count);

     }catch(err) {
         log.info(err.message);
         return false;
    }
   if (parseInt(count) <7){
       return true;
   } else {
      return false;
   }
}

使用规则定义模拟for循环

也可以使用“规则定义”作为路由表达式来模拟for循环。创建 count 变量属于Long数据类型。使用 表达式 作为中的映射模式 设置变量 步骤以设置值 count 变量到 count + 1 每次执行 设置变量 步骤。

模拟for循环

在 跳转步骤，使用 设置变量 作为 定位步骤 和 计数< 5 作为路由表达式。

模拟for循环的条件

此 设置变量 步骤重复运行，将 count 变量值1，直至该值达到5。

OR 拆分

此 OR拆分 在工作流中创建拆分，之后只有一个分支处于活动状态。此步骤允许您将条件处理路径引入工作流。您可以根据需要向每个分支添加工作流步骤。

注意

请参阅 OR拆分步骤

使用OR拆分进行分支

OR拆分 — 配置

要配置拆分，请执行以下操作：

编辑 OR拆分属性：
- 通用
  - 指定拆分名称。
- 分支(x)
  - 添加分支： 在步骤中添加更多分支。
  - 选择路由表达式：要计算活动分支，请选择路由表达式。可能的值包括：规则定义、外部脚本和ECMA脚本。
  - 单击以添加表达式：添加表达式以评估活动分支，如果您选择 规则定义 作为路由表达式。
  - 脚本路径：如果选择了某个文件，且该文件包含用于计算活动分支的脚本，则该文件的路径为 外部脚本 作为路由表达式。
  - 脚本：如果选中，则在框中添加脚本以计算活动分支 ECMA脚本 作为路由表达式。
  - 默认路由：如果有多个分支，则使用默认分支。您只能指定一个分支作为默认分支。
注意
- 每次根据路由表达式评估一个分支。
  - 将从上到下评估分支。
  - 执行第一个计算为true的脚本。
  - 如果没有分支的计算结果为true，则工作流不会前进。
注意

请参阅定义OR拆分规则.
根据需要将工作流步骤添加到分支。

参与者步骤和选择器

参与者步骤

A 参与者步骤 允许您为特定操作分配所有权。仅当用户手动确认该步骤时，工作流才会继续。当您希望某个人对工作流执行操作时，可使用此工作流。例如，审阅步骤。

虽然不直接相关，但在分配操作时必须考虑用户授权；用户必须具有对工作流有效负载页面的访问权限。

参与者步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
用户/组

注意

在以下情况下，将始终通知工作流启动器：

工作流已完成（已完成）。
工作流已中止（已终止）。

注意

必须配置某些属性以启用电子邮件通知。您还可以自定义电子邮件模板或添加新语言的电子邮件模板。要在AEM中配置电子邮件通知，请参阅配置电子邮件通知.

对话框参与者步骤

使用 对话框参与者步骤 向分配了工作项的用户收集信息。此步骤可用于收集稍后在工作流中使用的少量数据。

完成此步骤后， 完成工作项 对话框包含您在对话框中定义的字段。在字段中收集的数据存储在工作流有效负荷的节点中。然后，后续工作流步骤可以从存储库中读取值。

要配置该步骤，请指定要为其分配工作项的组或用户，以及对话框的路径。

对话框参与者步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
用户/组
对话框
- 对话框路径：的对话框节点的路径创建的对话框.

对话框参与者步骤 — 创建对话框

要创建对话框，必须创建对话框：

确定生成数据的位置存储在有效负载中.
定义对话框；包括定义用于收集和保存数据的字段.

对话框参与者步骤 — 在有效负荷中存储数据

您可以将构件数据存储在工作流有效负载或工作项元数据中。的格式 name widget节点的属性确定存储数据的位置。

使用有效负载存储数据
- 要将构件数据存储为工作流有效负荷的属性，请为构件节点的name属性的值使用以下格式：
  
  ./jcr:content/nodename
- 数据存储在 nodename 有效负载节点的属性。如果节点不包含该属性，则会创建属性。
- 与有效负载一起存储时，后续使用具有相同有效负载的对话框会覆盖属性的值。
使用工作项存储数据
- 要将小部件数据存储为工作项元数据的属性，请为name属性的值使用以下格式：
  
  nodename
- 数据存储在 nodename 工作项的属性 metadata. 如果之后对同一有效负载使用该对话框，则数据将保留。

对话框参与者步骤 — 对话框定义

对话框结构

对话框参与者步骤的对话框与为创作组件创建的对话框类似。它们存储在以下位置：

/apps/myapp/workflow/dialogs

标准触屏UI的对话框具有以下节点结构：
```
newComponent (cq:Component)
  |- cq:dialog (nt:unstructured)
    |- content
      |- layout
        |- items
          |- column
            |- items
              |- component0
              |- component1
              |- ...
```
注意

请参阅创建和配置对话框.
对话框路径属性

此 对话框参与者步骤 具有 对话框路径 属性(以及属性属于参与者步骤)。的值 对话框路径 属性是 dialog 对话框的节点。

例如，对话框包含在名为的组件中 EmailWatch 存储在节点中的内容：

/apps/myapp/workflows/dialogs

对于触屏优化UI，以下值用于 对话框路径 属性：

/apps/myapp/workflow/dialogs/EmailWatch/cq:dialog

示例对话框定义

以下XML代码段表示一个对话框，该对话框存储 String 中的值 watchEmail 有效负荷内容的节点。标题节点表示文本字段组件：

jcr:primaryType="nt:unstructured"
    jcr:title="Watcher Email Address Dialog"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content jcr:primaryType="nt:unstructured"
        sling:resourceType="granite/ui/components/foundation/container">
        <layout jcr:primaryType="nt:unstructured"
            margin="false"
            sling:resourceType="granite/ui/components/foundation/layouts/fixedcolumns"
        />
        <items jcr:primaryType="nt:unstructured">
            <column jcr:primaryType="nt:unstructured"
                sling:resourceType="granite/ui/components/foundation/container">
                <items jcr:primaryType="nt:unstructured">
                    <title jcr:primaryType="nt:unstructured"
                        fieldLabel="Notification Email Address"
                        name="./jcr:content/watchEmails"
                        sling:resourceType="granite/ui/components/foundation/form/textfield"
                    />
                </items>
            </column>
        </items>
    </content>
</cq:dialog>

在触屏优化UI中，此示例会生成一个对话框，如下所示：

chlimage_1-70

动态参与者步骤

此 动态参与者步骤 组件类似于 参与者步骤 不同之处在于，参与者会在运行时自动选择。

要配置该步骤，请选择 参与者选择器 用于标识要为其分配工作项的参与者，以及对话框。

动态参与者步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
参与者选择器
- 参与者选择器：的名称您创建的参与者选择器.
- 参数：任何必需的参数。
- 电子邮件：是否应向用户发送电子邮件通知。
对话框
- 对话框路径：的对话框节点的路径您创建的对话框(与 对话框参与者步骤).

动态参与者步骤 — 开发参与者选择器

创建参与者选择器。因此，您可以使用任何选择逻辑或标准。例如，参与者选择器可以选择（在组内）工作项最少的用户。您可以创建任意数量的参与者选择器，以用于 动态参与者步骤 工作流模型中的组件。

创建一个OSGi服务或一个ECMAScript ，用于选择要将工作项分配到的用户。

ECMAscript

脚本必须包含一个名为getParticipant的函数，该函数将用户ID作为 String 值。将自定义脚本存储在，例如 /apps/myapp/workflow/scripts 文件夹或子文件夹。

一个示例脚本包含在标准AEM实例中：

/libs/workflow/scripts/initiator-participant-chooser.ecma

注意

请勿更改 /libs 路径。

原因在于 /libs 下次升级实例时将被覆盖（应用修补程序或功能包时可能会被覆盖）。

此脚本选择工作流发起者作为参与者：
```
function getParticipant() {
    return workItem.getWorkflow().getInitiator();
}
```
注意

此 工作流发起者参与人选择器 组件扩展 动态参与者步骤 和使用此脚本作为步骤实施。
OSGi服务

服务必须实施 com.day.cq.workflow.exec.ParticipantStepChooser 界面。该界面定义了以下成员：
- SERVICE_PROPERTY_LABEL 字段：使用此字段可指定参与者选择器的名称。该名称会显示在中的可用参与者选择器列表中 动态参与者步骤 属性。
- getParticipant 方法：返回动态解析的主体ID，作为 String 值。
注意

此 getParticipant 方法会返回动态解析的主体ID。此id可以是组id或用户id。

但是，组ID只能用于 参与者步骤，返回参与者列表时。对于 动态参与者步骤，将返回空列表，无法用于委派。

使您的实施可用于 动态参与者步骤 组件，将您的Java™类添加到导出服务的OSGi捆绑包中，并将该捆绑包部署到AEM服务器。

注意

随机参与者选择器 是一个选择随机用户的示例服务( com.day.cq.workflow.impl.process.RandomParticipantChooser)。此 随机参与者选择 r步骤组件示例扩展 动态参与者步骤 并将此服务用作步骤实施。

动态参与者步骤 — 参与者选择器服务示例

以下Java™类实现 ParticipantStepChooser 界面。此类将返回启动工作流的参与者的姓名。该代码使用的逻辑与示例脚本(initiator-participant-chooser.ecma)使用。

此 @Property 注释设置 SERVICE_PROPERTY_LABEL 字段至 Workflow Initiator Participant Chooser.

package com.adobe.example;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.ParticipantStepChooser;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.metadata.MetaDataMap;

@Component
@Service
@Properties({
        @Property(name = Constants.SERVICE_DESCRIPTION, value = "An example implementation of a dynamic participant chooser."),
        @Property(name = ParticipantStepChooser.SERVICE_PROPERTY_LABEL, value = "Workflow Initiator Participant Chooser (service)") })
public class InitiatorParticipantChooser implements ParticipantStepChooser {

 private Logger logger = LoggerFactory.getLogger(this.getClass());

 public String getParticipant(WorkItem arg0, WorkflowSession arg1,
   MetaDataMap arg2) throws WorkflowException {

  String initiator = arg0.getWorkflow().getInitiator();
  logger.info("Assigning Dynamic Participant Step work item to {}",initiator);

  return initiator;
 }
}

在 动态参与者步骤 属性对话框， 参与者选择器 列表包含项目 Workflow Initiator Participant Chooser (script)，表示此服务。

启动工作流模型时，日志会指示启动工作流的用户ID以及分配了工作项的用户ID。在此示例中， admin 用户已启动工作流。

13.09.2015 15:48:53.037 *INFO* [10.176.129.223 [1347565733037] POST /etc/workflow/instances HTTP/1.1] com.adobe.example.InitiatorParticipantChooser Assigning Dynamic Participant Step work item to admin

表单参与者步骤

此 表单参与者步骤 在工作项打开时显示窗体。当用户填写并提交表单时，字段数据存储在工作流有效负荷的节点中。

要配置该步骤，请指定要为其分配工作项的组或用户，以及窗体的路径。

注意

本节将介绍用于页面创作的基础组件的“Forms”部分.

表单参与者步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
用户/组
表单
- 表单路径：的路径您创建的表单.

表单参与者步骤 — 创建表单

创建用于的表单 表单参与者步骤 正常的。但是，表单参与者步骤的表单必须具有以下配置：

此 表单的开头 组件必须具有 操作类型 属性设置为 Edit Workflow Controlled Resource(s).
此 表单的开头 组件必须具有值 Form Identifier 属性。
表单组件必须具有 元素名称 属性设置为存储字段数据的节点的路径。路径必须在工作流有效负荷内容中找到节点。该值使用以下格式：

./jcr:content/path_to_node
表单必须包含 工作流提交按钮 组件。您未配置组件的任何属性。

工作流的要求决定了字段数据的存储位置。例如，字段数据可用于配置页面内容的属性。以下值 元素名称 属性将字段数据存储为 redirectTarget 的属性 jcr:content 节点：

./jcr:content/redirectTarget

在以下示例中，字段数据用作文本有效负载页面上的组件：

./jcr:content/par/text_3/text

第一个示例可用于满足以下条件的任何页面 cq:Page 组件渲染。第二个示例只能在有效负荷页面包含文本 ID为的组件 text_3.

表单可位于存储库中的任意位置，但必须授权工作流用户阅读表单。

随机参与者选择器

此 随机参与者选择器 步骤是一个参与者选择器，用于将生成的工作项分配给从列表中随机选择的用户。

wf-31

随机参与者选择器 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
参数
- 参与者：指定可供选择的用户列表。要将用户添加到列表，请单击 添加项目 并键入用户节点的主目录路径或用户ID。用户的顺序不会影响分派工作项的可能性。

工作流发起者参与人选择器

此 工作流发起者参与人选择器 步骤是一个参与者选择器，用于将生成的工作项分配给启动工作流的用户。除属性之外，没有要配置的属性公共属性。

工作流发起者参与人选择器 — 配置

要配置该步骤，请使用以下选项卡进行编辑：

通用

流程步骤

A 流程步骤 执行ECMAScript或调用OSGi服务以执行自动处理。

wf-32

流程步骤 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
进程
- 进程：要执行的进程实施。使用下拉菜单选择ECMAScript或OSGi服务。有关信息:
  - 标准ECMAScript和OSGi服务，请参见用于流程步骤的内置流程.
  - 为流程步骤创建ECMAScript，请参见使用ECMAScript实施流程步骤.
  - 为流程步骤创建OSGi服务，请参阅使用Java™类实施流程步骤.
- 处理程序前进：选择此选项可自动将工作流前进到执行后的下一个步骤。如果未选中，则实施脚本必须处理工作流提升。
- 参数：要传递给进程的参数。

设置变量

“设置变量”步骤允许您设置变量的值并定义值的设置顺序。变量将按照变量映射在“设置变量”步骤中列出的顺序进行设置。

添加映射以设置变量

设置变量 — 配置

要配置该步骤，请编辑并使用以下选项卡：

通用
映射
- 选择变量： 使用此选项可选择变量以设置其值。
- 选择映射模式： 要设置变量的值，请选择映射模式。根据变量的数据类型，您可以使用以下选项设置变量的值：
  - 文本： 知道要指定的确切值时使用选项。
  - 表达式： 在根据表达式计算要使用的值时，使用选项。表达式是在提供的表达式编辑器中创建的。
  - JSON点表示法： 使用选项从JSON或FDM类型变量检索值。
  - XPATH： 使用选项可从XML类型变量中检索值。
  - 相对于有效负荷： 当要保存到变量的值在有效负荷的相对路径上可用时，请使用选项。
  - 绝对路径： 当要保存到变量的值在绝对路径上可用时，请使用选项。
- 指定值： 要映射到变量，请指定值。在此字段中指定的值取决于映射模式。
- 添加映射： 使用此选项可添加更多映射以设置变量的值。

工作流步骤参考

步骤属性

步骤属性 — 常用选项卡

步骤属性 — 用户/组选项卡

AND 拆分

AND拆分 — 配置

容器步骤

容器步骤 — 配置

跳转步骤

跳转步骤 — 配置

模拟for循环

使用规则定义模拟for循环

OR 拆分

OR拆分 — 配置

参与者步骤和选择器

参与者步骤

参与者步骤 — 配置

对话框参与者步骤

对话框参与者步骤 — 配置

对话框参与者步骤 — 创建对话框

对话框参与者步骤 — 在有效负荷中存储数据

对话框参与者步骤 — 对话框定义

动态参与者步骤

动态参与者步骤 — 配置

动态参与者步骤 — 开发参与者选择器

动态参与者步骤 — 参与者选择器服务示例

表单参与者步骤

表单参与者步骤 — 配置

表单参与者步骤 — 创建表单

随机参与者选择器

随机参与者选择器 — 配置

工作流发起者参与人选择器

工作流发起者参与人选择器 — 配置

流程步骤

流程步骤 — 配置

设置变量

设置变量 — 配置

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe