Referencia de pasos de flujo de trabajo workflow-step-reference
Los modelos de flujo de trabajo constan de una serie de pasos de varios tipos. Según el tipo, estos pasos se pueden configurar y ampliar con parámetros y secuencias de comandos para proporcionar la funcionalidad y el control que necesite.
Propiedades de la etapa step-properties
Cada componente de paso tiene un Propiedades de los pasos que permite definir y editar las propiedades requeridas.
Propiedades de los pasos: ficha Común step-properties-common-tab
Hay disponible una combinación de las siguientes propiedades para la mayoría de los componentes de paso del flujo de trabajo, en la variable Frecuentes del cuadro de diálogo de propiedades:
-
Título
Título del paso.
-
Descripción
Descripción del paso.
-
Fase del flujo de trabajo
Un selector desplegable para aplicar un Prueba al paso.
-
Tiempo de espera
El periodo después del cual se "agotó el tiempo de espera" para el paso.
Puede seleccionar entre: Off, Inmediato, 1h, 6h, 12h, 24 h.
-
Controlador de tiempo de espera
El controlador que controlará el flujo de trabajo cuando se agote el tiempo de espera del paso; por ejemplo:
Auto Advancer
-
Avance de controlador
Seleccione esta opción para avanzar automáticamente el flujo de trabajo al paso siguiente después de la ejecución. Si no se selecciona, la secuencia de comandos de implementación debe gestionar el progreso del flujo de trabajo.
Propiedades de los pasos: ficha Usuario/Grupo step-properties-user-group-tab
Las siguientes propiedades están disponibles para muchos componentes de paso del flujo de trabajo, en la variable Usuario/Grupo del cuadro de diálogo de propiedades:
-
Notificar al usuario a través del correo electrónico
- Puede notificar a los participantes enviándoles un correo electrónico cuando el flujo de trabajo llega al paso.
- Si se habilita, se enviará un correo electrónico al usuario definido por la propiedad Usuario/Grupo o a cada miembro del grupo si se define un grupo.
-
Usuario/grupo
- Un cuadro de selección desplegable le permite desplazarse y seleccionar un usuario o grupo.
- Si asigna el paso a un usuario específico, solo este usuario puede realizar una acción en el paso.
- Si asigna el paso a un grupo completo, cuando el flujo de trabajo alcance este paso, todos los usuarios de este grupo tendrán la acción en su Bandeja de entrada del flujo de trabajo.
- Consulte Participación en flujos de trabajo para obtener más información.
División Y and-split
La variable División AND crea una división en el flujo de trabajo, tras la cual ambas ramas estarán activas. Los pasos del flujo de trabajo se agregan a cada rama según sea necesario. Este paso le permite introducir varias rutas de procesamiento en el flujo de trabajo. Por ejemplo, puede permitir que ciertos pasos de revisión se produzcan en paralelo, lo que ahorra tiempo.
División AND: Configuración and-split-configuration
-
Edite el División AND propiedades:
- Nombre de división: asignar un nombre a efectos explicativos.
- Seleccione el número de ramas necesarias; 2, 3, 4 o 5.
-
Añada los pasos del flujo de trabajo a las ramas según sea necesario.
Etapa del contenedor container-step
A Contenedor el paso inicia otro modelo de flujo de trabajo que se ejecuta como flujo de trabajo secundario.
Esta Contenedor permite reutilizar modelos de flujo de trabajo para implementar secuencias comunes de pasos. Por ejemplo, se puede utilizar un modelo de flujo de trabajo de traducción en varios flujos de trabajo de edición.
Paso de contenedor: configuración container-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Contenedor
- Subflujo de trabajo: Seleccione el flujo de trabajo que desea iniciar.
Ir a la etapa goto-step
La variable Ir al paso permite especificar el siguiente paso en el modelo de flujo de trabajo que se ejecutará, según el resultado de un ECMAScript:
-
true
: La variable Ir al paso finaliza y el motor de flujo de trabajo ejecuta el paso especificado. -
false
: La variable Ir al paso completa y la lógica de enrutamiento normal determina el siguiente paso que se va a ejecutar.
La variable Ir al paso permite implementar estructuras de enrutamiento avanzadas en los modelos de flujo de trabajo. Por ejemplo, para implementar un bucle, la variable Ir al paso se puede definir para ejecutar un paso anterior en el flujo de trabajo, con la secuencia de comandos evaluando una condición de bucle.
Ir al paso: configuración goto-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Proceso
- El paso a seguir: Seleccione el paso que desea ejecutar.
- Ruta de acceso del script: La ruta al ECMAScript que determina si se ejecutará la variable Ir al paso.
- Secuencia de comandos: El ECMAScript que determina si se ejecutará la variable Ir al paso.
Simulación de un bucle for simulating-a-for-loop
Para simular un bucle for es necesario mantener un recuento del número de iteraciones de bucle que se han producido:
- El recuento representa normalmente un índice de elementos en los que se actúa en el flujo de trabajo.
- El recuento se evalúa como criterios de salida del bucle.
Por ejemplo, para implementar un flujo de trabajo que realice una acción en varios nodos JCR, puede utilizar un contador de bucle como índice para los nodos. Para mantener el recuento, almacene un integer
en el mapa de datos de la instancia de flujo de trabajo. Utilice la secuencia de comandos del Ir al paso para incrementar el recuento y comparar el recuento con los criterios de salida.
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;
}
}
División O or-split
La variable División OR crea una división en el flujo de trabajo, tras lo cual solo se activará una rama. Este paso le permite introducir rutas de procesamiento condicionales en su flujo de trabajo. Los pasos del flujo de trabajo se agregan a cada rama según sea necesario.
División OR: configuración or-split-configuration
-
Edite el División OR propiedades:
-
Común
- Seleccione el número de ramas necesarias; 2, 3, 4 o 5.
-
Rama : x>
- Ruta de acceso del script: Ruta de acceso a un archivo que contiene la secuencia de comandos.
- Secuencia de comandos: Añada la secuencia de comandos en el cuadro .
- Ruta predeterminada: La rama predeterminada se sigue cuando varias ramas se evalúan como verdaderas. Solo se puede especificar una rama como la predeterminada.
note note NOTE Hay una pestaña independiente para cada rama: - La secuencia de comandos de cada rama se evalúa de una en una.
- Las ramas se evalúan de izquierda a derecha.
- Se ejecuta la primera secuencia de comandos que evalúa como verdadera.
- Si ninguna rama se evalúa como verdadera, el flujo de trabajo no avanza.
note caution CAUTION Especifique la variable Ruta de acceso del script o Secuencia de comandos. Ambas opciones no se pueden usar al mismo tiempo. Si especifica valores para ambas propiedades, el paso utiliza la variable Ruta de acceso del script. note note NOTE Consulte Definición de una regla para una división OR. -
-
Añada los pasos del flujo de trabajo a las ramas según sea necesario.
Pasos y opciones del participante participant-steps-and-choosers
Etapa de participante participant-step
A Etapa de participante permite asignar la propiedad a una acción determinada. El flujo de trabajo solo se realizará cuando el usuario haya reconocido manualmente el paso. Se utiliza cuando desea que alguien realice una acción en el flujo de trabajo; por ejemplo, un paso de revisión.
Aunque no está directamente relacionada, se debe tener en cuenta la autorización del usuario al asignar una acción; el usuario debe tener acceso a la página que es la carga útil del flujo de trabajo.
Etapa de participante: configuración participant-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
- El flujo de trabajo se ha completado (finalizado).
- El flujo de trabajo se interrumpe (termina).
Etapa de participante de cuadro de diálogo dialog-participant-step
Utilice un Etapa de participante del cuadro de diálogo para recopilar información del usuario al que se asigna el elemento de trabajo. Este paso es útil para recopilar pequeñas cantidades de datos que se utilizan más adelante en el flujo de trabajo.
Al completar el paso, la variable Completar elemento de trabajo contiene los campos definidos en el cuadro de diálogo. Los datos recopilados en los campos se almacenan en los nodos de la carga útil del flujo de trabajo. Los pasos subsiguientes del flujo de trabajo pueden leer el valor del repositorio.
Para configurar el paso, especifique el grupo o usuario al que desea asignar el elemento de trabajo y la ruta al cuadro de diálogo.
Etapa de participante del cuadro de diálogo: configuración dialog-participant-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Cuadro de diálogo
- Ruta de diálogo: La ruta al nodo de diálogo del cuadro de diálogo que cree.
Etapa de participante del cuadro de diálogo: creación de un cuadro de diálogo dialog-participant-step-creating-a-dialog
Para crear un cuadro de diálogo:
- Decida dónde se encontrarán los datos resultantes almacenado en la carga útil.
- Definir el cuadro de diálogo; esto incluye la definición de los campos utilizados para recopilar (y guardar) los datos.
Paso de participante del cuadro de diálogo: almacenamiento de datos en la carga útil dialog-participant-step-storing-data-in-the-payload
Puede almacenar datos de widget en la carga útil del flujo de trabajo o en los metadatos del elemento de trabajo. El formato de la variable name
propiedad del nodo widget determina dónde se almacenan los datos.
-
Almacenar datos con la carga útil
-
Para almacenar datos de widget como propiedad de la carga útil del flujo de trabajo, utilice el siguiente formato para el valor de la propiedad name del nodo de widget:
./jcr:content/nodename
-
Los datos se almacenan en la variable
nodename
propiedad del nodo de carga útil. Si el nodo no contiene esa propiedad, se crea la propiedad . -
Cuando se almacena con la carga útil, los usos subsiguientes del cuadro de diálogo con la misma carga útil sobrescriben el valor de la propiedad .
-
-
Almacenar datos con el elemento de trabajo
-
Para almacenar datos de widget como propiedad de los metadatos del elemento de trabajo, utilice el siguiente formato para el valor de la propiedad name :
nodename
-
Los datos se almacenan en la variable
nodename
propiedad del elemento de trabajometadata
. Los datos se conservan si el cuadro de diálogo se utiliza posteriormente con la misma carga útil.
-
Etapa del participante del cuadro de diálogo: definición del cuadro de diálogo dialog-participant-step-dialog-definition
-
Estructura del cuadro de diálogo
Los cuadros de diálogo Pasos de los participantes son similares a los cuadros de diálogo que crea para crear componentes. Se almacenan en:
/apps/myapp/workflow/dialogs
Los cuadros de diálogo para la IU táctil estándar tienen la siguiente estructura de nodos:
code language-xml newComponent (cq:Component) |- cq:dialog (nt:unstructured) |- content |- layout |- items |- column |- items |- component0 |- component1 |- ...
note note NOTE Para obtener más información, consulte Creación y configuración de un cuadro de diálogo. -
Propiedad Dialog Path
La variable Etapa de participante del cuadro de diálogo tiene la variable Ruta de diálogo (junto con las propiedades de un Etapa de participante). El valor de la variable Ruta de diálogo es la ruta a la
dialog
del cuadro de diálogo.Por ejemplo, el cuadro de diálogo está contenido en un componente denominado
EmailWatch
que se almacena en el nodo :/apps/myapp/workflows/dialogs
Para la IU táctil se utiliza el siguiente valor para la variable Ruta de diálogo propiedad:
/apps/myapp/workflow/dialogs/EmailWatch/cq:dialog
-
Ejemplo de definición de cuadro de diálogo
El siguiente fragmento de código XML representa un cuadro de diálogo que almacena un
String
en la variablewatchEmail
del contenido de carga útil. El nodo de título representa la variable CampoTexto componente:code language-xml 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>
Este ejemplo dará como resultado, en el caso de la IU táctil, un cuadro de diálogo como:
Etapa de participante dinámica dynamic-participant-step
La variable Etapa de participante dinámica es similar a Etapa de participante con la diferencia de que el participante se selecciona automáticamente en tiempo de ejecución.
Para configurar el paso, seleccione una Selector de participante que identifica al participante al que asignar el elemento de trabajo, junto con un cuadro de diálogo.
Etapa de participante dinámica: configuración dynamic-participant-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Selector de participantes
- Selector de participante: El nombre del selector de participantes que cree.
- Argumentos: Cualquier argumento necesario.
- Correo electrónico: Si se debe enviar una notificación por correo electrónico al usuario.
-
Cuadro de diálogo
- Ruta de diálogo: La ruta al nodo de diálogo del diálogo que cree (como con el Etapa de participante del cuadro de diálogo).
Etapa de participante dinámica: desarrollo del selector de participantes dynamic-participant-step-developing-the-participant-chooser
Usted crea el selector de participantes. Por lo tanto, puede utilizar cualquier lógica o criterio de selección. Por ejemplo, el selector de participantes puede seleccionar el usuario (dentro de un grupo) que tenga la menor cantidad de elementos de trabajo. Puede crear cualquier número de usuarios que desee utilizar con diferentes instancias de la variable Etapa de participante dinámica en los modelos de flujo de trabajo.
Cree un servicio OSGi o un ECMAScript que seleccione un usuario al que asignar el elemento de trabajo.
-
ECMAscript
Las secuencias de comandos deben incluir una función denominada getParticipant que devuelva un ID de usuario como
String
valor. Almacene los scripts personalizados en, por ejemplo, la variable/apps/myapp/workflow/scripts
o una subcarpeta.Se incluye un script de ejemplo en una instancia de AEM estándar:
/libs/workflow/scripts/initiator-participant-chooser.ecma
note caution CAUTION You must no cambie nada en la variable /libs
ruta.Esto se debe a que el contenido de /libs
se sobrescribe la próxima vez que actualice la instancia (y se puede sobrescribir al aplicar una corrección o un paquete de funciones).Esta secuencia de comandos selecciona el iniciador del flujo de trabajo como participante:
code language-none function getParticipant() { return workItem.getWorkflow().getInitiator(); }
note note NOTE La variable Selector de participante del iniciador de flujo de trabajo amplía el Etapa de participante dinámica y utiliza esta secuencia de comandos como implementación de paso. -
Servicio OSGi
Los servicios deben implementar la variable com.day.cq.workflow.exec.ParticipantStepChooser interfaz. La interfaz define los siguientes miembros:
SERVICE_PROPERTY_LABEL
campo: Utilice este campo para especificar el nombre del selector de participantes. El nombre aparece en una lista de los usuarios participantes disponibles en la Etapa de participante dinámica propiedades.getParticipant
método: Devuelve el identificador principal resuelto dinámicamente como unString
valor.
note caution CAUTION La variable getParticipant
devuelve el identificador principal resuelto dinámicamente. Puede ser un id de grupo o un id de usuario.Sin embargo, un id de grupo solo se puede usar para un Etapa de participante, cuando se devuelve una lista de participantes. Para un Etapa de participante dinámica se devuelve una lista vacía, que no se puede usar para la delegación. Para que la implementación esté disponible para Etapa de participante dinámica , añada su clase Java a un paquete OSGi que exporte el servicio e implemente el paquete en el servidor AEM.
note note NOTE Selector de participante aleatorio es un servicio de ejemplo que selecciona un usuario aleatorio ( com.day.cq.workflow.impl.process.RandomParticipantChooser
). La variable Selector de participante aleatorio el ejemplo de componente de paso amplía el Etapa de participante dinámica y utiliza este servicio como implementación de paso.
Etapa de participante dinámica: servicio de selección de participantes de ejemplo dynamic-participant-step-example-participant-chooser-service
La siguiente clase Java implementa el ParticipantStepChooser
interfaz. La clase devuelve el nombre del participante que inició el flujo de trabajo. El código utiliza la misma lógica que la secuencia de comandos de ejemplo ( initator-participant-chooser.ecma
).
La variable @Property
la anotación define el valor de la variable SERVICE_PROPERTY_LABEL
campo a 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;
}
}
En el Etapa de participante dinámica cuadro de diálogo de propiedades, Selector de participante La lista incluye el elemento Workflow Initiator Participant Chooser (script)
, que representa este servicio.
"Cuando se inicia el modelo de flujo de trabajo, el registro indica el ID del usuario que inició el flujo de trabajo y al que se asigna el elemento de trabajo. En este ejemplo, la variable admin
el usuario inició el flujo de trabajo.
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
Etapa de participante de formulario form-participant-step
La variable Etapa de participante del formulario presenta un formulario cuando se abre el elemento de trabajo. Cuando el usuario rellena y envía el formulario, los datos del campo se almacenan en los nodos de la carga útil del flujo de trabajo.
Para configurar el paso, debe especificar el grupo o usuario al que asignar el elemento de trabajo y la ruta al formulario.
Etapa del participante del formulario: configuración form-participant-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Formulario
- Ruta del formulario: La ruta al formulario creado.
Paso del participante en el formulario: Creación del formulario form-participant-step-creating-the-form
Cree un formulario para utilizarlo con un Etapa de participante del formulario como normal. Sin embargo, los formularios para una etapa de participante en el formulario deben tener las siguientes configuraciones:
-
La variable Inicio de formulario debe tener el Tipo de acción propiedad establecida en
Edit Workflow Controlled Resource(s)
. -
La variable Inicio de formulario debe tener un valor para la variable
Form Identifier
propiedad. -
Los componentes de formulario deben tener la variable Nombre del elemento propiedad establecida en la ruta del nodo en el que se almacenan los datos del campo. La ruta debe localizar un nodo en el contenido de carga útil del flujo de trabajo. El valor utiliza el siguiente formato:
./jcr:content/path_to_node
-
El formulario debe incluir un Botones de envío de flujo de trabajo componente. No se configura ninguna propiedad del componente.
Los requisitos del flujo de trabajo determinan dónde se deben almacenar los datos de campo. Por ejemplo, los datos de campo se pueden utilizar para configurar las propiedades del contenido de la página. El siguiente valor de un Nombre del elemento la propiedad almacena datos de campo como el valor del redirectTarget
propiedad de la variable jcr:content
nodo:
./jcr:content/redirectTarget
En el ejemplo siguiente, los datos de campo se utilizan como contenido de un Texto en la página de carga útil:
./jcr:content/par/text_3/text
"El primer ejemplo se puede usar para cualquier página en la que la variable cq:Page
se procesa el componente. El segundo ejemplo solo se puede usar cuando la página de carga útil incluye un Texto componente que tiene un ID de text_3
.
El formulario puede encontrarse en cualquier lugar del repositorio, pero los usuarios del flujo de trabajo deben estar autorizados para leer el formulario.
Selector aleatorio de participantes random-participant-chooser
La variable Selector de participante aleatorio es un selector de participantes que asigna el elemento de trabajo generado a un usuario que se selecciona aleatoriamente en una lista.
Selector de participante aleatorio: configuración random-participant-chooser-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Argumentos
- Participantes: Especifica la lista de usuarios disponibles para la selección. Para agregar un usuario a la lista, haga clic en Agregar elemento y escriba la ruta principal del nodo de usuario o del ID de usuario. El orden de los usuarios no afecta a la probabilidad de que se les asigne un elemento de trabajo.
Selector de participantes del lanzador de flujo de trabajo workflow-initiator-participant-chooser
La variable Selector de participante del iniciador de flujo de trabajo es un selector de participantes que asigna el elemento de trabajo generado al usuario que inició el flujo de trabajo. No hay propiedades para configurar que no sean la Frecuentes propiedades.
Selector de participante del iniciador de flujo de trabajo: configuración workflow-initiator-participant-chooser-configuration
Para configurar el paso, edite mediante las siguientes pestañas:
Etapa del proceso process-step
A Paso de proceso ejecuta un ECMAScript o llama a un servicio OSGi para realizar el procesamiento automático.
Paso de proceso: Configuración process-step-configuration
Para configurar el paso, edite y utilice las siguientes pestañas:
-
Proceso
-
Proceso: Implementación del proceso que se va a ejecutar. Utilice el menú desplegable para seleccionar el servicio ECMAScript o OSGi. Para obtener información acerca de:
- Los servicios estándar ECMAScripts y OSGi, consulte Procesos integrados para pasos de proceso.
- Creación de ECMAScripts para un Proceso paso, consulte Implementación de un paso de proceso con un ECMAScript.
- Creación de servicios OSGi para un Proceso paso, consulte Implementación de un paso de proceso con una clase Java.
-
Avance del controlador: Seleccione esta opción para avanzar automáticamente el flujo de trabajo al paso siguiente después de la ejecución. Si no se selecciona, la secuencia de comandos de implementación debe gestionar el progreso del flujo de trabajo.
-
Argumentos: Argumentos que se van a pasar al proceso.
-