Referencia de pasos de flujo de trabajo

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.

NOTA

Esta sección cubre los pasos estándar del flujo de trabajo.

Para ver los pasos específicos del módulo, consulte también:

Propiedades de la etapa

Cada componente de paso tiene un cuadro de diálogo Propiedades del paso que permite definir y editar las propiedades requeridas.

Propiedades de los pasos: pestaña común

Hay disponible una combinación de las siguientes propiedades para la mayoría de los componentes de paso del flujo de trabajo, en la pestaña Common del cuadro de diálogo de propiedades:

  • Título

    Título del paso.

  • Descripción

    Descripción del paso.

  • Fase del flujo de trabajo

    Selector desplegable para aplicar un Stage al paso.

  • Tiempo de espera

    El periodo después del cual se "agotó el tiempo de espera" para el paso.

    Puede seleccionar entre: Desactivado, Inmediato, 1h, 6h, 12h, 24h.

  • 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

Las siguientes propiedades están disponibles para muchos componentes de paso del flujo de trabajo, en la pestaña 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 está habilitado, se enviará un correo electrónico al usuario definido por la propiedad User/Group 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 AND

La AND Split 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.

wf-26

División AND: Configuración

  • Edite las propiedades AND Split:

    • Nombre dividido: 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.

    wf-27

Paso de contenedor

Un paso Container inicia otro modelo de flujo de trabajo que se ejecuta como flujo de trabajo secundario.

Este contenedor le 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.

wf-28

Paso del contenedor: Configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

  • Común

  • Contenedor

    • Subflujo de trabajo: Seleccione el flujo de trabajo que desea iniciar.

Ir a la etapa

El Goto Step permite especificar el siguiente paso en el modelo de flujo de trabajo que se ejecutará, según el resultado de un ECMAScript:

  • true: El paso Ir a se completa y el motor de flujo de trabajo ejecuta el paso especificado.

  • false: Los Pasos Ir a completan y la lógica de enrutamiento normal determina el siguiente paso que se va a ejecutar.

El Goto Step permite implementar estructuras de enrutamiento avanzadas en los modelos de flujo de trabajo. Por ejemplo, para implementar un bucle, el Goto Step puede definirse 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

Para configurar el paso, edite y utilice las siguientes pestañas:

  • Común

  • Proceso

    • El paso que debe seguir: Seleccione el paso que desea ejecutar.
    • Ruta de script: Ruta al ECMAScript que determina si se ejecutará el paso Ir a.
    • Script: El ECMAScript que determina si se ejecutará el paso Ir a.
PRECAUCIÓN

Especifique la Ruta de script o el Script. Ambas opciones no se pueden usar al mismo tiempo. Si especifica valores para ambas propiedades, el paso utiliza la Ruta de script.

Simulación de un bucle for

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 valor integer en el mapa de datos de la instancia de flujo de trabajo. Utilice la secuencia de comandos del Goto Step 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 OR

La OR Split crea una división en el flujo de trabajo, tras la cual solo se activará una rama. Este paso le permite introducir rutas de procesamiento condicionales en el flujo de trabajo. Los pasos del flujo de trabajo se agregan a cada rama según sea necesario.

NOTA

Para obtener más información sobre la creación de una división OR, consulte: https://helpx.adobe.com/experience-manager/using/aem64_workflow_servlet.html

wf-29

OR Split - Configuración

  • Edite las propiedades OR Split:

    • Común

      • Seleccione el número de ramas necesarias; 2, 3, 4 o 5.
    • Rama : x>

      • Ruta de script: Ruta de acceso a un archivo que contiene la secuencia de comandos.
      • Script: 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.
    NOTA

    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.
    PRECAUCIÓN

    Especifique la Ruta de script o el Script. Ambas opciones no se pueden usar al mismo tiempo. Si especifica valores para ambas propiedades, el paso utiliza la Ruta de script.

  • Añada los pasos del flujo de trabajo a las ramas según sea necesario.

Pasos y opciones del participante

Etapa de participante

Un paso de participante le permite asignar la propiedad de una acción en particular. 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.

Paso del participante: Configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

NOTA

El iniciador del flujo de trabajo siempre recibe una notificación cuando:

  • El flujo de trabajo se ha completado (finalizado).
  • El flujo de trabajo se interrumpe (termina).
NOTA

Es necesario configurar algunas propiedades para habilitar las notificaciones por correo electrónico. También puede personalizar la plantilla de correo electrónico o añadir una plantilla de correo electrónico para un nuevo idioma. Consulte Configuración de notificaciones por correo electrónico para configurar las notificaciones por correo electrónico en AEM.

Etapa de participante de cuadro de diálogo

Utilice un paso del participante del cuadro de diálogo para recopilar información del usuario al que se ha asignado 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, el cuadro de diálogo Completar elemento de trabajo contiene los campos que se definen 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 del participante del cuadro de diálogo: configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

Etapa de participante del cuadro de diálogo: creación de un cuadro de diálogo

Para crear un cuadro de diálogo:

Paso de participante del cuadro de diálogo: Almacenamiento de datos en la carga útil

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 propiedad name del nodo del 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 propiedad nodename 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 propiedad nodename del elemento de trabajo metadata. 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

  1. 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:

    newComponent (cq:Component)
      |- cq:dialog (nt:unstructured)
        |- content 
          |- layout 
            |- items 
              |- column 
                |- items 
                  |- component0
                  |- component1
                  |- ...
    
    NOTA

    Para obtener más información, consulte Creación y configuración de un cuadro de diálogo.

  2. Propiedad Dialog Path

    El paso del participante del cuadro de diálogo tiene la propiedad Ruta de diálogo (junto con las propiedades de un paso del participante). El valor de la propiedad Dialog Path es la ruta al nodo 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 propiedad Dialog Path:

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

    wf-30

  3. 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 valor String en el nodo watchEmail del contenido de carga útil. El nodo de título representa el componente TextField:

    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:

    chlimage_1-177

Etapa de participante dinámica

El componente Paso de participante dinámico es similar a Paso de participante con la diferencia de que el participante se selecciona automáticamente en tiempo de ejecución.

Para configurar el paso, seleccione un Selector de participantes que identifique al participante al que asignar el elemento de trabajo, junto con un cuadro de diálogo.

Etapa de participante dinámica: configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

Etapa de participante dinámica: desarrollo del selector de participantes

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 distintas instancias del componente Paso de participante dinámico 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 valor String. Almacene los scripts personalizados en, por ejemplo, la carpeta /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

    PRECAUCIÓN

    no debe cambiar nada en la ruta /libs.

    Esto se debe a que el contenido de /libs se sobrescribe la próxima vez que actualice la instancia (y puede sobrescribirse al aplicar una corrección o un paquete de funciones).

    Esta secuencia de comandos selecciona el iniciador del flujo de trabajo como participante:

    function getParticipant() {
        return workItem.getWorkflow().getInitiator();
    }
    
    NOTA

    El componente Selector de participante del iniciador de flujo de trabajo amplía el paso de participante dinámico y utiliza este script como implementación de paso.

  • Servicio OSGi

    Los servicios deben implementar la interfaz com.day.cq.workflow.exec.ParticipantStepChooser. 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 seleccionadores de participantes disponibles en las propiedades Paso de participante dinámico.
    • getParticipant método: Devuelve el identificador principal resuelto dinámicamente como String valor.
    PRECAUCIÓN

    El método getParticipant devuelve el identificador principal resuelto dinámicamente. Puede ser un id de grupo o un id de usuario.

    Sin embargo, un identificador de grupo solo se puede utilizar para una etapa de participante, cuando se devuelve una lista de participantes. Para un paso de participante dinámico, se devuelve una lista vacía que no se puede usar para la delegación.

    Para que la implementación esté disponible para los componentes de Paso de participante dinámico , añada su clase Java a un paquete OSGi que exporte el servicio e implemente el paquete en el servidor AEM.

    NOTA

    El selector de participantes aleatorios es un servicio de muestra que selecciona un usuario aleatorio ( com.day.cq.workflow.impl.process.RandomParticipantChooser). El ejemplo de componente de paso Selector de participante aleatorio amplía el paso de participante dinámico y utiliza este servicio como implementación de paso.

Etapa de participante dinámica: Ejemplo de servicio de selector de participantes

La siguiente clase Java implementa la interfaz ParticipantStepChooser. 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 anotación @Property establece el valor del campo SERVICE_PROPERTY_LABEL en 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 cuadro de diálogo de propiedades Paso de participante dinámico , la lista Selector de participante 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, el usuario admin 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

El paso del participante en el 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.

PRECAUCIÓN

Paso del participante en el formulario: Configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

Paso del participante en el formulario: Creación del formulario

Cree un formulario para utilizarlo con un paso del participante en el formulario como de costumbre. Sin embargo, los formularios para una etapa de participante en el formulario deben tener las siguientes configuraciones:

  • El componente Inicio del formulario debe tener la propiedad Tipo de acción establecida en Edit Workflow Controlled Resource(s).

  • El componente Inicio del formulario debe tener un valor para la propiedad Form Identifier.

  • Los componentes de formulario deben tener la propiedad Element Name 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 componente Workflow Submit Button(s). 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 una propiedad Element Name almacena los datos de campo como el valor de la propiedad redirectTarget del nodo jcr:content:

./jcr:content/redirectTarget

En el siguiente ejemplo, los datos de campo se utilizan como contenido de un componente Text en la página de carga útil:

./jcr:content/par/text_3/text

"El primer ejemplo se puede utilizar para cualquier página que muestre el componente cq:Page. El segundo ejemplo solo se puede utilizar cuando la página de carga útil incluye un componente Text 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 de participante aleatorio

El paso 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.

wf-31

Selector de participante aleatorio: configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

  • Común

  • 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 del usuario o el ID de usuario. El orden de los usuarios no afecta a la probabilidad de que se les asigne un elemento de trabajo.

Selector de participante de iniciador de flujo de trabajo

El paso 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 las propiedades Common.

Selector de participante del iniciador de flujo de trabajo: configuración

Para configurar el paso, edite mediante las siguientes pestañas:

Etapa del proceso

Un paso de proceso ejecuta un ECMAScript o llama a un servicio OSGi para realizar el procesamiento automático.

wf-32

Paso del proceso: Configuración

Para configurar el paso, edite y utilice las siguientes pestañas:

  • Común

  • 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:

    • 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.

En esta página