以Forms为中心的AEM工作流中的变量

工作流模型中的变量是一种根据值的数据类型来存储值的方法。 您可以在任何工作流步骤中使用变量的名称来检索存储在变量中的值。 您还可以使用变量名称定义用于做出路由决策的表达式。

在AEM工作流模型中,您可以:

  • 根据 要存储在其中的信息类型创建数据类型的变量。
  • 使用设置变量工作 流步骤为变量设置值。
  • 在所有工 作流步 AEM Forms 骤中使用变量检索存储的值,在OR拆分和跳转步骤中使用变量定义路由表达式。

以下视频演示了如何在AEM工作流模型中创建、设置和使用变量:

[!VIDEO] (assets/variables_introduction_1_1.mp4)

变量是现有MetaDataMap接口的扩展。 您可以在ECMAScript中使用MetaDataMap访问使用变量保存的元数据。

创建变量

您可以使用工作流模型Sidekick中提供的“变量”部分创建变量。 AEM工作流变量支持以下数据类型:

  • 基元数据类型:Long、Double、Boolean、Date和String
  • 复杂数据类型: 文档XMLJSON和表单数据模型实例。
注意

工作流仅支持ISO8601格式的日期类型变量。

使用ArrayList数据类型创建变量集合。 您可以为所有基元和复杂数据类型创建ArrayList变量。 例如,创建一个ArrayList变量并选择String作为子类型,以使用该变量存储多个字符串值。

要创建变量,请执行以下操作:

  1. 在AEM实例上,导航至工具 >工作流>模型。

  2. 点按​Create ,然后为工作流模型指定标题和可选名称。 选择模型并点按​Edit

  3. 点按工作流模型Sidekick中可用的变量图标,然后点按​Add Variable

    添加变量

  4. 在添加变量对话框中,指定名称并选择变量的类型。

  5. 从​Type​下拉列表中选择数据类型,并指定以下值:

    • 基元数据类型 — 为变量指定可选的默认值。
    • JSON或XML — 指定可选的JSON或XML架构路径。 当将此模式中可用的属性映射到另一个变量并将其存储到另一个变量时,系统将验证模式路径。
    • 表单数据模型 — 指定表单数据模型路径。
    • ArrayList — 为集合指定子类型。
  6. 为变量指定可选描述,然后点按done_icon以保存更改。 变量显示在左侧窗格的可用列表中。

在创建变量时,请考虑以下实践:

  • 根据工作流的需要创建任意数量的变量。 但是,为了节省数据库资源,请尽可能使用所需变量的最少数量,并重用变量。
  • 变量区分大小写。 确保在工作流中使用相同的大小写引用变量。
  • 避免在变量名称中使用特殊字符

设置变量

您可以使用设置变量步骤来设置变量的值并定义值的设置顺序。 变量按变量映射在设置变量步骤中列出的顺序进行设置。

变量值的更改仅影响发生更改的流程实例。 例如,当启动工作流并更改变量数据时,所做的更改仅会影响该工作流实例。 这些更改不会影响之前启动或稍后启动的工作流的其他实例。

根据变量的数据类型,您可以使用以下选项设置变量的值:

  • 文字: 当您知道要指定的确切值时,请使用选项。您还可以使用选项以字符串形式指定JSON。

  • 表达式: 根据表达式计算要使用的值时,请使用选项。表达式在提供的表达式编辑器中创建。

  • JSON点表示法: 使用选项从JSON或FDM类型变量中检索值。

  • XPATH: 使用选项从XML类型变量中检索值。

  • 相对于有效负载: 如果要保存到变量的值在相对于有效负载的路径上可用,请使用选项。

  • 绝对路径: 如果要保存到变量的值在绝对路径中可用,请使用选项。

您还可以使用JSON点表示法或XPATH表示法来更新JSON或XML类型变量的特定元素。

添加变量之间的映射

要添加变量之间的映射,请执行以下操作:

  1. 在工作流编辑页面上,点按工作流模型Sidekick中可用的步骤图标。
  2. 将​Set Variable​步骤拖放到工作流编辑器中,点按该步骤,然后选择configure_icon(Configure)。
  3. 在“设置变量”对话框中,选择​Mapping > Add Mapping
  4. 在​映射变量​部分中,选择要存储数据的变量,选择映射模式,并指定要存储在变量中的值。 映射模式因变量类型而异。
  5. 映射更多变量以生成有意义的表达式。 点按done_icon以保存更改。

示例1:查询XML变量以设置字符串变量的值

选择XML类型的变量以存储XML文件。 查询XML变量,为XML文件中可用的属性设置字符串变量的值。 使用​为XML变量​字段指定XPATH ,以定义要存储在字符串变量中的属性。

在此示例中,选择​formdata XML变量以存储​cc-app.xml​文件。 查询​formdata​变量以设置​emailaddress​字符串变量的值,以存储​cc-app.xml​文件中可用​emailAddress​属性的值。

示例2:使用表达式根据其他变量存储值

使用表达式计算变量的总和并将结果存储到变量中。

在此示例中,使用表达式编辑器定义表达式来计算​assetscost​和​balanceamount​变量的和,并将结果存储在​totalvalue​变量中。

使用表达式编辑器

您还可以使用表达式在运行时计算变量的值。 变量提供用于定义表达式的表达式编辑器。

使用表达式编辑器可执行以下操作:

  • 使用其他工作流变量、数字或数学表达式设置变量的值。
  • 在数学表达式中使用工作流变量、字符串、数字或表达式
  • 添加条件以设置变量值。
  • 在条件之间添加运算符。

表达式编辑器

它基于自适应Forms规则编辑器,且进行了以下更改。 变量中的规则编辑器:

  • 不支持函数。
  • 不提供用于查看规则摘要的UI
  • 没有代码编辑器。
  • 不支持启用和禁用对象的值。
  • 不支持对象的设置属性。
  • 不支持调用Web服务。

有关更多信息,请参阅自适应Forms规则编辑器

使用变量

您可以使用变量检索输入和输出或保存步骤结果。 工作流编辑器提供了两种类型的工作流步骤:

  • 支持变量的工作流步骤
  • 不支持变量的工作流步骤

支持变量的工作流步骤

转到步骤、或拆分步骤以及所有AEM Forms工作流步骤都支持变量。

或拆分步骤

“或拆分”(OR Split)在工作流中创建一个拆分,在该拆分之后,只有一个分支处于活动状态。 通过此步骤,您可以在工作流中引入条件处理路径。 您可以根据需要向每个分支添加工作流步骤。

您可以使用规则定义、ECMA脚本或外部脚本为分支定义路由表达式。

您可以使用变量通过表达式编辑器定义路由表达式。 有关在“或拆分”步骤中使用路由表达式的详细信息,请参阅OR拆分步骤

在此示例中,在定义路由表达式之前,请使用示例2来设置​totalvalue​变量的值。 如果​totalvalue​变量的值大于50000,则分支1处于活动状态。 同样,如果​totalvalue​变量的值小于50000,则可以定义一个规则以使分支2处于活动状态。

同样,选择外部脚本路径或指定路由表达式的ECMA脚本以计算活动分支。 点按​Rename Branch​以指定分支的替代名称。

转至步骤

通过​转到步骤,您可以根据路由表达式的结果,指定要执行的工作流模型中的下一步。

与“或拆分”步骤类似,您可以使用规则定义、ECMA脚本或外部脚本定义跳转步骤的路由表达式。

您可以使用变量通过表达式编辑器定义路由表达式。 有关在跳转步骤中使用路由表达式的详细信息,请参阅跳转步骤

跳转规则

在此示例中,如果​actiontaked​变量的值等于​需要更多信息,则跳转步骤会指定审核信用卡应用程序作为下一步。

有关在跳转步骤中使用规则定义的更多示例,请参阅模拟For循环

以Forms为中心的工作流步骤

所有AEM Forms工作流步骤都支持变量。 有关更多信息,请参阅OSGi🔗上以Forms为中心的工作流。

不支持变量的工作流步骤

您可以使用MetaDataMap界面访问不支持变量的工作流步骤中的变量。

检索变量值

在ECMA脚本中使用以下API来根据数据类型检索现有变量的值:

变量数据类型 API
基元(长、双精度、布尔、日期和字符串) workItem.getWorkflowData()。getMetaDataMap()。get(variableName, type)
文档 Packages.com.adobe.aemfd.docmanager.Document doc = workItem.getWorkflowData()。getMetaDataMap()。get("docVar", Packages.com.adobe.aemfd.docmanager.Document.class);
XML Packages.org.w3c.dom.Document xmlObject = workItem.getWorkflowData()。getMetaDataMap()。get(variableName, Packages.org.w3c.dom.Document.class);
表单数据模型 Packages.com.adobe.aem.dermis.api.FormDataModelInstanceFdmObject = workItem.getWorkflowData()。getMetaDataMap()。get(variableName, Packages.com.adobe.aem.dermis.api.FormDataModelInstance.class);
JSON Packages.com.google.gson.JsonObject jsonObject = workItem.getWorkflowData()。getMetaDataMap()。get(variableName, Packages.com.google.gson.JsonObject.class);

示例

使用以下API检索字符串数据类型的值:

workItem.getWorkflowData().getMetaDataMap().get(accname, Packages.java.lang.String)

更新变量值

在ECMA脚本中使用以下API来更新变量的值:

workItem.getWorkflowData().getMetaDataMap().put(variableName, value)

示例

workItem.getWorkflowData().getMetaDataMap().put(salary, 50000)

将​salary​变量的值更新为50000。

设置变量以调用工作流

您可以使用API设置变量并传递它们以调用工作流实例。

workflowSession. startWorkflow使用模型、wfData和metaData作为参数。使用MetaDataMap为变量设置值。

在此API中,使用metaData.put(variableName, value)将​variableName​变量设置为​value;

import com.adobe.granite.workflow.model.WorkflowModel;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import com.adobe.aemfd.docmanager.Document;

/*Assume that you already have a workflowSession and modelId along with the payloadType and payload*/
WorkflowData wfData = workflowSession.newWorkflowData(payloadType, payload);
MetaDataMap metaData = wfData.getMetaDataMap();
metaData.put(variableName, value); //Create a variable "variableName" in your workflow model
WorkflowModel model = workflowSession.getModel(modelId);
workflowSession.startWorkflow(model, wfData, metaData);

示例

将​doc​文档对象初始化为路径("a/b/c"),并将​docVar​变量的值设置为存储在文档对象中的路径。

import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.model.WorkflowModel;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import com.adobe.aemfd.docmanager.Document;

/*This example assumes that you already have a workflowSession and modelId along with the payloadType and payload */
WorkflowData wfData = workflowSession.newWorkflowData(payloadType, payload);
MetaDataMap metaData = wfData.getMetaDataMap();
Document doc = new Document("/a/b/c");// initialize a document object
metaData.put("docVar",doc); //Assuming that you have created a variable "docVar" of type Document in your workflow model
WorkflowModel model = workflowSession.getModel(modelId);
workflowSession.startWorkflow(model, wfData, metaData);

编辑变量

  1. 在编辑工作流页面,点按工作流模型Sidekick中可用的变量图标。 左窗格中的“变量”部分显示所有现有变量。
  2. 点按要编辑的变量名称旁边的编辑(编辑)图标。
  3. 编辑变量信息,然后点按done_icon以保存更改。 无法编辑变量的​Name​和​Type​字段。

删除变量

在删除变量之前,请从工作流中删除该变量的所有引用。 确保未在工作流中使用变量。

要删除变量,请执行以下操作:

  1. 在编辑工作流页面,点按工作流模型Sidekick中可用的变量图标。 左窗格中的“变量”部分显示所有现有变量。
  2. 点按要删除的变量名称旁边的删除图标。
  3. 点按done_icon以确认和删除变量。

引用

有关在AEM Forms工作流步骤中使用变量的更多示例,请参阅AEM工作流中的变量

在此页面上