Variables en flujos de trabajo de AEM Forms

Una variable en un modelo de flujo de trabajo es una forma de almacenar un valor en función de su tipo de datos. A continuación, puede utilizar el nombre de la variable en cualquier paso del flujo de trabajo para recuperar el valor almacenado en la variable. También puede utilizar nombres de variables para definir expresiones para tomar decisiones de enrutamiento.

En AEM modelos de flujo de trabajo, puede:

• Cree una variable de un tipo de datos en función del tipo de información que desee almacenar en él.
• Establezca un valor para la variable mediante el paso de flujo de trabajo Establecer variable.
• Utilice la variable en todos los pasos del flujo de trabajo de AEM Forms para recuperar el valor almacenado y en los pasos O Dividir y Ir para definir una expresión de enrutamiento.

En el siguiente vídeo se muestra cómo crear, establecer y utilizar variables en AEM modelos de flujo de trabajo:

Las variables son una extensión de la interfaz MetaDataMap existente. Puede utilizar MetaDataMap en ECMAScript para acceder a los metadatos guardados mediante variables.

Crear una variable

Las variables se crean mediante la sección Variables disponible en la barra de tareas del modelo de flujo de trabajo. AEM variables de flujo de trabajo admiten los siguientes tipos de datos:

• Tipos de datos primitivos: Long, Doble, Boolean, Date y String
• Tipos de datos complejos: Documento, XML, JSON y la instancia del modelo de datos de formulario.

Se requiere paquete de complemento de AEM Forms para los tipos de datos de modelo de datos de Documento y formulario. Utilice el tipo de datos ArrayList para crear colecciones de variables. Puede crear una variable ArrayList para todos los tipos de datos primitivos y complejos. Por ejemplo, cree una variable ArrayList y seleccione String como subtipo para almacenar varios valores de cadena mediante la variable.

Ejecute los siguientes pasos para crear una variable:

1. En una instancia de AEM, vaya a Herramientas > Flujo de trabajo > Modelos.

2. Toque Crear y especifique el título y un nombre opcional para el modelo de flujo de trabajo. Seleccione el modelo y toque Editar.

3. Toque el icono de variables disponible en la barra de tareas del modelo de flujo de trabajo y toque Añadir variable.

   

4. En el cuadro de diálogo Añadir variable, especifique el nombre y seleccione el tipo de la variable.

5. Seleccione el tipo de datos en la lista desplegable Tipo y especifique los siguientes valores:

   • Tipo de datos primitivo: especifique un valor predeterminado opcional para la variable.
   • JSON o XML: especifique una ruta de esquema JSON o XML opcional. El sistema valida la ruta de esquema mientras asigna y almacena las propiedades disponibles en este esquema a otra variable.
   • Modelo de datos de formulario: especifique una ruta del modelo de datos de formulario.
   • ArrayList: especifique un subtipo para la colección.

6. Especifique una descripción opcional para la variable y toque para guardar los cambios. La variable se muestra en la lista disponible en el panel izquierdo.

Cuando cree variables, tenga en cuenta las siguientes prácticas:

• Cree tantas variables como necesite un flujo de trabajo. Sin embargo, para conservar los recursos de la base de datos, utilice el número mínimo de variables requeridas y reutilice las variables cuando sea posible.
• Las variables distinguen entre mayúsculas y minúsculas. Asegúrese de hacer referencia a variables usando el mismo caso en el flujo de trabajo.
• Evite utilizar caracteres especiales en el nombre de la variable

Configure una variable

Puede utilizar el paso Establecer variable para establecer el valor de una variable y definir el orden en que se configuran los valores. La variable se establece en el orden en que las asignaciones de variables se enumeran en el paso de la variable establecida.

Los cambios en los valores de las variables afectan únicamente a la instancia del proceso en el que se produce el cambio. Por ejemplo, cuando se inicia un flujo de trabajo y cambian los datos variables, los cambios solo afectan a esa instancia del flujo de trabajo. Los cambios no afectan a otras instancias del flujo de trabajo que se iniciaron anteriormente o que se iniciaron posteriormente.

Según el tipo de datos de la variable, puede utilizar las siguientes opciones para establecer el valor de una variable:

• Literal: utilice la opción cuando sepa el valor exacto que desea especificar.

• Expresión: utilice la opción cuando el valor que se va a utilizar se calcule en función de una expresión. La expresión se crea en el editor de expresiones proporcionado.

• Notación de punto JSON: utilice la opción para recuperar un valor de una variable de tipo JSON o FDM.

• XPATH: utilice la opción para recuperar un valor de una variable de tipo XML.

• Relativo a la carga útil: utilice la opción cuando el valor que se va a guardar en la variable esté disponible en una ruta relativa a la carga útil.

• Ruta absoluta: utilice la opción cuando el valor que se va a guardar en la variable esté disponible en una ruta absoluta.

También puede actualizar elementos específicos de una variable de tipo JSON o XML mediante notación DOT JSON o notación XPATH.

Añadir la asignación entre variables

Ejecute los siguientes pasos para agregar la asignación entre variables:

1. En la página de edición del flujo de trabajo, toque el icono Pasos disponible en la barra de tareas del modelo de flujo de trabajo.
2. Arrastre y suelte el paso Establecer variable en el editor de flujo de trabajo, toque el paso y seleccione (Configurar).
3. En el cuadro de diálogo Establecer variable, seleccione Asignación > Añadir asignación.
4. En la sección Variable de mapa, seleccione la variable para almacenar datos, seleccione el modo de asignación y especifique un valor para almacenarlo en la variable. Los modos de asignación varían según el tipo de variable.
5. Asigne más variables para realizar una expresión significativa. Toque para guardar los cambios.

Ejemplo 1: Consulta de una variable XML para establecer el valor de una variable de cadena

Seleccione una variable de tipo XML para almacenar un archivo XML. Consulta la variable XML para establecer el valor de una variable de cadena para la propiedad disponible en el archivo XML. Utilice Especifique XPATH para el campo de variable XML para definir la propiedad que se almacenará en la variable de cadena.

En este ejemplo, seleccione una variable formdata XML para almacenar el archivo cc-app.xml. Consulta la variable formdata para establecer el valor de la variable de cadena email a fin de almacenar el valor de la propiedad emailAddress disponible en el archivo cc-app.xml.

Ejemplo 2: Utilice una expresión para almacenar valores basados en otras variables

Utilice una expresión para calcular la suma de las variables y almacenar el resultado en una variable.

En este ejemplo, utilice el editor de expresiones para definir una expresión que calcule la suma de las variables value y balanceamount y almacene el resultado en la variable totalvalue.

Usar editor de expresiones

También se utilizan expresiones para calcular el valor de una variable en tiempo de ejecución. Las variables proporcionan un editor de expresiones para definir expresiones.

Utilice el editor de expresiones para:

• Establezca el valor de las variables mediante otras variables de flujo de trabajo, números o expresiones matemáticas.
• Usar variables de flujo de trabajo, cadena, número o una expresión dentro de una expresión matemática
• Añada las condiciones para establecer los valores de las variables.
• Añadir operadores entre condiciones.

Se basa en el editor de reglas de formularios adaptables con los siguientes cambios. Editor de reglas en variables:

• No admite funciones.
• No proporciona una interfaz de usuario para el resumen de vista de reglas
• No tiene editor de código.
• No admite la activación y desactivación del valor de un objeto.
• No admite la propiedad de configuración de un objeto.
• No admite llamar a un servicio Web.

Para obtener más información, consulte editor de reglas de formularios adaptables.

Utilice una variable

Puede utilizar variables para recuperar entradas y salidas o guardar el resultado de un paso. El editor de flujo de trabajo proporciona dos tipos de pasos de flujo de trabajo:

• Pasos de flujo de trabajo compatibles con variables
• Pasos del flujo de trabajo sin compatibilidad con variables

Pasos del flujo de trabajo compatibles con las variables

El paso Ir a, O Dividir y todos los pasos del flujo de trabajo de AEM Forms admiten variables.

O dividir paso

La división O crea una división en el flujo de trabajo, tras la cual solo una rama está activa. Este paso le permite introducir rutas de procesamiento condicionales en el flujo de trabajo. Puede agregar pasos de flujo de trabajo a cada rama según sea necesario.

Puede definir la expresión de enrutamiento para una rama mediante una definición de regla, una secuencia de comandos ECMA o una secuencia de comandos externa.

Puede utilizar variables para definir la expresión de enrutamiento mediante el editor de expresiones. Para obtener más información sobre el uso de expresiones de enrutamiento para el paso O Dividir, consulte OR Split step.

En este ejemplo, antes de definir la expresión de enrutamiento, utilice ejemplo 2 para establecer el valor de la variable totalvalue. La rama 1 está activa si el valor de la variable totalvalue es bueno a 50000. Del mismo modo, puede definir una regla para activar la rama 2 si el valor de la variable totalvalue es menor que 50000.

Del mismo modo, seleccione una ruta de script externa o especifique la secuencia de comandos ECMA para expresiones de enrutamiento para evaluar la rama activa. Toque Cambiar nombre de rama para especificar un nombre alternativo para la rama.

Para obtener más ejemplos, consulte Creación de un modelo de workflow.

Ir al paso

El Paso Goto permite especificar el siguiente paso en el modelo de flujo de trabajo que se va a ejecutar, según el resultado de una expresión de enrutamiento.

De forma similar al paso División OR, puede definir la expresión de enrutamiento para el paso Goto mediante una definición de regla, una secuencia de comandos ECMA o una secuencia de comandos externa.

Puede utilizar variables para definir la expresión de enrutamiento mediante el editor de expresiones. Para obtener más información sobre el uso de expresiones de enrutamiento para el paso Goto, consulte Goto Step.

En este ejemplo, el paso Goto especifica la Aplicación de tarjeta de crédito de revisión como el siguiente paso si el valor de la variable actiontake es igual a Necesita más información.

Para obtener más ejemplos sobre el uso de la definición de regla en el paso Ir, consulte Simulación de un bucle For.

Pasos del flujo de trabajo centrado en el flujo de trabajo de Forms

Todos los pasos del flujo de trabajo de AEM Forms admiten variables. Para obtener más información, consulte Flujo de trabajo centrado en Forms en OSGi.

Pasos del flujo de trabajo sin compatibilidad con variables

Puede utilizar la interfaz MetaDataMap para acceder a las variables en los pasos del flujo de trabajo que no admiten variables.

Recuperar el valor de variable

Utilice las siguientes API en el script ECMA para recuperar los valores de las variables existentes según el tipo de datos:

Tipo de datos variable	API
Primitiva (larga, Doble, booleana, fecha y cadena)	workItem.getWorkflowData().getMetaDataMap().get(variableName, type)
Documento	Packages.com.adobe.aemfd.docmanager.Documento doc = workItem.getWorkflowData().getMetaDataMap().get("docVar", Packages.com.adobe.aemfd.docmanager.Documento.class);
XML	Packages.org.w3c.dom.Documento xmlObject = workItem.getWorkflowData().getMetaDataMap().get(variableName, Packages.org.w3c.dom.Documento.class);
Modelo de datos de formulario	Packages.com.adobe.aem.dermis.api.FormDataModelInstance fdmObject = 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);

Se requiere paquete de complemento de AEM Forms para los tipos de datos de variables de modelo de datos de Documento y formulario.

Ejemplo

Recupere el valor del tipo de datos de cadena mediante la siguiente API:

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

Actualice el valor de la variable

Utilice la siguiente API en el script ECMA para actualizar el valor de una variable:

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

Ejemplo

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

actualiza el valor de la variable salario a 50000.

Configure las variables para invocar flujos de trabajo

Puede utilizar una API para establecer variables y pasarlas para invocar instancias de flujo de trabajo.

workflowSession. startWorkflowuses model, wfData y metaData como argumentos. Utilice MetaDataMap para establecer el valor de la variable.

En esta API, la variable variableName se establece en valor mediante metaData.put(variableName, valor);

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);

Ejemplo

Inicialice el objeto de documento doc a una ruta ("a/b/c") y establezca el valor de la variable docVar en la ruta almacenada en el objeto de documento.

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);

Editar una variable

1. En la página de flujo de trabajo de edición, toque el icono Variables disponible en la barra de tareas del modelo de flujo de trabajo. La sección Variables del panel izquierdo muestra todas las variables existentes.
2. Toque el icono (Editar) junto al nombre de la variable que desee editar.
3. Edite la información de la variable y toque para guardar los cambios. No se pueden editar los campos Nombre y Tipo para una variable.

Eliminar una variable

Antes de eliminar la variable, elimine todas las referencias de la misma del flujo de trabajo. Asegúrese de que la variable no se utilice en el flujo de trabajo.

Ejecute los siguientes pasos para eliminar una variable:

1. En la página de flujo de trabajo de edición, toque el icono Variables disponible en la barra de tareas del modelo de flujo de trabajo. La sección Variables del panel izquierdo muestra todas las variables existentes.
2. Toque el icono Eliminar junto al nombre de la variable que desee eliminar.
3. Toque para confirmar y eliminar la variable.

Referencias

Para obtener más ejemplos sobre el uso de variables en los pasos del flujo de trabajo de AEM Forms, consulte Variables en AEM flujos de trabajo.