以Forms为中心的AEM Workflow中的变量 variables-in-aem-forms-workflows
工作流模型中的变量是一种根据其数据类型存储值的方法。 您可以在任何工作流步骤中使用变量的名称来检索存储在变量中的值。 您还可以使用变量名称来定义用于制定路由决策的表达式。
在AEM工作流模型中,您可以:
以下视频演示如何在AEM Workflow模型中创建、设置和使用变量:
变量是现有变量的扩展 元数据映射 界面。 您可以使用 元数据映射 在ECMAScript中访问使用变量保存的元数据。
创建变量 create-a-variable
您可以使用工作流模型Sidekick中提供的“变量”部分创建变量。 AEM工作流变量支持以下数据类型:
使用ArrayList数据类型创建变量集合。 您可以为所有原始和复杂数据类型创建ArrayList变量。 例如,创建一个ArrayList变量并选择String作为子类型,以使用该变量存储多个字符串值。
要创建变量,请执行以下操作:
-
在AEM实例上,导航到工具 >工作流>模型。
-
选择 创建 并指定工作流模型的标题和可选名称。 选择模型并选择 编辑.
-
选择工作流模型Sidekick中可用的变量图标,然后选择 添加变量.
-
在添加变量对话框中,指定变量名称并选择变量类型。
-
从中选择数据类型 类型 下拉列表,并指定以下值:
- 原始数据类型 — 为变量指定可选的默认值。
- JSON或XML — 指定可选的JSON或XML架构路径。 系统将此架构中可用的属性映射并存储到其他变量时,验证架构路径。
- 表单数据模型 — 指定表单数据模型路径。
- ArrayList — 指定集合的子类型。
-
为变量指定可选描述,然后选择 以保存更改。 变量将显示在左侧窗格中可用的列表中。
创建变量时,请考虑以下实践:
- 创建工作流所需的任意数量的变量。 但是,为了节约数据库资源,应使用所需的最小变量数,并尽可能重用变量。
- 变量区分大小写。 确保在工作流中使用相同的大小写引用变量。
- 避免在变量的名称中使用特殊字符
设置变量 set-a-variable
您可以使用“设置变量”步骤来设置变量的值,并定义值的设置顺序。 变量按照变量映射在设置变量步骤中列出的顺序进行设置。
对变量值所做的更改只会影响发生更改的进程实例。 例如,在启动工作流并更改变量数据时,所做的更改仅影响工作流的该实例。 这些更改不会影响之前启动或稍后启动的工作流的其他实例。
根据变量的数据类型,您可以使用以下选项设置变量的值:
-
文本: 知道要指定的确切值时使用选项。 您还可以使用选项以字符串的形式指定JSON。
-
表达式: 在根据表达式计算要使用的值时,使用选项。 表达式是在提供的表达式编辑器中创建的。
-
JSON点表示法: 使用选项从JSON或FDM类型变量检索值。
-
XPATH: 使用选项可从XML类型变量中检索值。
-
相对于有效负荷: 当要保存到变量的值在有效负荷的相对路径上可用时,请使用选项。
-
绝对路径: 当要保存到变量的值在绝对路径上可用时,请使用选项。
您还可以使用JSON点表示法或XPATH表示法更新JSON或XML类型变量的特定元素。
添加变量之间的映射 add-mapping-between-variables
要添加变量之间的映射,请执行以下操作:
- 在工作流编辑页面上,选择工作流模型Sidekick中可用的步骤图标。
- 拖放 设置变量 步骤到工作流编辑器,选择该步骤并选择 (配置)。
- 在设置变量对话框中,选择 映射 > 添加映射.
- 在 映射变量 部分,选择要存储数据的变量,选择映射模式,然后指定要在变量中存储的值。 映射模式因变量类型而异。
- 映射更多变量以生成有意义的表达式。 选择 以保存更改。
示例1:查询XML变量以设置字符串变量的值 example-query-an-xml-variable-to-set-value-for-a-string-variable
选择XML类型的变量以存储XML文件。 查询XML变量以为XML文件中可用的属性设置字符串变量的值。 使用 指定XML变量的XPATH 字段,用于定义要在字符串变量中存储的属性。
在此示例中,选择 formdata 用于存储的XML变量 cc-app.xml 文件。 查询 formdata 变量来设置值 电子邮件地址 字符串变量,用于存储值 电子邮件地址 中可用的属性 cc-app.xml 文件。
示例2:使用表达式存储基于其他变量的值 example2
使用表达式计算变量的总和并将结果存储在变量中。
在本例中,使用表达式编辑器定义一个表达式以计算 assetscost 和 余额金额 变量并将结果存储在 totalvalue 变量。
使用表达式编辑器 use-expression-editor
您还可以在运行时使用表达式计算变量的值。 变量提供用于定义表达式的表达式编辑器。
使用表达式编辑器可以:
- 使用其他工作流变量、数字或数学表达式设置变量的值。
- 在数学表达式中使用工作流变量、字符串、数字或表达式
- 添加条件以设置变量的值。
- 在条件之间添加运算符。
它基于自适应Forms规则编辑器,进行了以下更改。 变量中的规则编辑器:
- 不支持函数。
- 不提供用于查看规则摘要的UI
- 没有代码编辑器。
- 不支持启用和禁用对象的值。
- 不支持设置对象的属性。
- 不支持调用Web服务。
有关更多信息,请参阅 自适应Forms规则编辑器.
使用变量 use-a-variable
可使用变量检索输入和输出或保存步骤的结果。 工作流编辑器提供两种类型的工作流步骤:
- 支持变量的工作流步骤
- 不支持变量的工作流步骤
支持变量的工作流步骤 workflow-steps-with-support-for-variables
转至步骤、OR拆分步骤以及所有 AEM Forms 工作流步骤支持变量。
OR拆分步骤 or-split-step
OR拆分在工作流中创建拆分,之后只有一个分支处于活动状态。 此步骤允许您将条件处理路径引入工作流。 您可以根据需要向每个分支添加工作流步骤。
您可以使用规则定义、ECMA脚本或外部脚本为分支定义路由表达式。
您可以使用变量来定义使用表达式编辑器的路由表达式。 有关对OR拆分步骤使用路由表达式的详细信息,请参阅 OR拆分步骤.
在此示例中,在定义路由表达式之前,使用 示例2 设置值 totalvalue 变量。 分支1处于活动状态,如果 totalvalue 变量大于50000。 同样,您可以定义一个规则以使Branch 2处于活动状态,如果 totalvalue 变量小于50000。
同样,选择外部脚本路径或指定路由表达式的ECMA脚本以计算活动分支。 选择 重命名分支 指定分支的替代名称。
转到步骤 go-to-step
此 跳转步骤 允许您根据路由表达式的结果,指定要执行的工作流模型中的下一步。
与OR拆分步骤类似,您可以使用规则定义、ECMA脚本或外部脚本为Goto步骤定义路由表达式。
您可以使用变量来定义使用表达式编辑器的路由表达式。 有关为“转至”步骤使用路由表达式的详细信息,请参阅 跳转步骤.
在本例中,如果 已执行操作 变量等于 需要更多信息.
有关在“转至”步骤中使用规则定义的更多示例,请参阅 模拟For循环.
以Forms为中心的工作流步骤 forms-workflow-centric-workflow-steps
全部 AEM Forms 工作流步骤支持变量。 有关更多信息,请参阅 OSGi上以Forms为中心的工作流.
不支持变量的工作流步骤 workflow-steps-without-support-for-variables
您可以使用 元数据映射 界面,用于在不支持变量的工作流步骤中访问变量。
检索变量值 retrieve-the-variable-value
在ECMA脚本中使用以下API根据数据类型检索现有变量的值:
示例
使用以下API检索字符串数据类型的值:
workItem.getWorkflowData().getMetaDataMap().get(accname, Packages.java.lang.String)
更新变量值 update-the-variable-value
在ECMA脚本中使用以下API来更新变量的值:
workItem.getWorkflowData().getMetaDataMap().put(variableName, value)
示例
workItem.getWorkflowData().getMetaDataMap().put(salary, 50000)
更新值 薪金 变量50000。
设置变量以调用工作流 apiinvokeworkflow
您可以使用API来设置变量,并传递它们以调用工作流实例。
workflowSession.startWorkflow 使用model、wfData和metaData作为参数。 使用MetaDataMap设置变量的值。
在此API中, variableName 变量设置为 值 使用metaData.put(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);
示例
初始化 文档 将文档对象放置到路径("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);
编辑变量 edit-a-variable
- 在编辑工作流页面上,选择工作流模型Sidekick中可用的“变量”图标。 左窗格中的变量部分显示所有现有变量。
- 选择 (编辑)图标(位于要编辑的变量名称旁)。
- 编辑变量信息并选择 以保存更改。 您无法编辑 名称 和 类型 变量对应的字段。
删除变量 delete-a-variable
在删除变量之前,请从工作流中删除变量的所有引用。 确保在工作流中未使用变量。
要删除变量,请执行以下操作:
- 在编辑工作流页面上,选择工作流模型Sidekick中可用的“变量”图标。 左窗格中的变量部分显示所有现有变量。
- 选择要删除的变量名称旁边的删除图标。
- 选择 以确认并删除该变量。
引用 references
有关在中使用变量的更多示例 AEM Forms 工作流步骤,请参见 AEM工作流中的变量.