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 pueden configurarse y ampliarse con parámetros y secuencias de comandos para proporcionar la funcionalidad y el control que necesite.

Propiedades de la etapa

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

Propiedades del paso: ficha Común

Hay una combinación de las siguientes propiedades disponibles para la mayoría de los componentes de pasos del flujo de trabajo, en la ficha Común 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 escenario al paso.

• Tiempo de espera

  Período después del cual se "agotó el tiempo de espera" del 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; 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 avance del flujo de trabajo.

Propiedades del paso: ficha Usuario/Grupo

Las siguientes propiedades están disponibles para muchos componentes de paso de flujo de trabajo, en la ficha 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 llegue al paso.
  • Si está habilitada, 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 permitirá desplazarse y seleccionar un usuario o grupo.
  • Si asigna el paso a un usuario específico, sólo este usuario puede realizar una acción en el paso.
  • Si asigna el paso a un grupo completo, cuando el flujo de trabajo llegue a este paso todos los usuarios de este grupo tendrán la acción en la bandeja de entrada ​​del flujo de trabajo.
  • Consulte Participación en Flujos de trabajo para obtener más información.

División AND

La división Y crea una división en el flujo de trabajo, tras la cual ambas ramas estarán activas. Puede agregar pasos de flujo de trabajo 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

• Edite las propiedades AND Split :

  • Nombre dividido: asignar un nombre para fines 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.

  

Paso de contenedor

Un paso de Contenedor inicio 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, un modelo de flujo de trabajo de traducción podría utilizarse en varios flujos de trabajo de edición.

Paso de contenedor: Configuración

Para configurar el paso, edite y utilice las fichas siguientes:

• Común

• Contenedor

  • Subflujo de trabajo: Seleccione el flujo de trabajo para el inicio.

Ir a la etapa

El paso ​​Ir permite especificar el siguiente paso en el modelo de flujo de trabajo que se va a ejecutar, según el resultado de un ECMAScript:

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

• false:: Se completa el paso ​​Goto y la lógica de enrutamiento normal determina el siguiente paso que se va a ejecutar.

El paso ​​Goto le permite implementar estructuras de enrutamiento avanzadas en los modelos de flujo de trabajo. Por ejemplo, para implementar un bucle, se puede definir Goto Step 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 fichas siguientes:

• Común

• Proceso

  • Paso a seguir: Seleccione el paso que desea ejecutar.
  • Ruta de script: Ruta de acceso al ECMAScript que determina si se ejecuta el paso Goto.
  • Secuencia de comandos: El ECMAScript que determina si se ejecuta el paso Ir.

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 el criterio de salida del bucle.

Por ejemplo, para implementar un flujo de trabajo que realiza 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 valor en el mapa de datos de la instancia de flujo de trabajo. Utilice la secuencia de comandos del paso ​​Goto 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 división O 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. Puede agregar pasos de flujo de trabajo a cada rama según sea necesario.

División O - Configuración

• Edite las propiedades O Dividir :

  • 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.
    • 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 true. Sólo puede especificar una rama como predeterminada.
  Nota

  Hay una ficha separada 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 se evalúa como true.
  • Si ninguna rama se evalúa como verdadera, el flujo de trabajo no avanza.
  PRECAUCIÓN

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

  Nota

  Consulte Definición de una regla para una divisiónO.

• 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 permite asignar la propiedad de una acción en particular. El flujo de trabajo sólo se realizará cuando el usuario haya reconocido manualmente el paso. Se utiliza cuando se desea que alguien realice una acción en el flujo de trabajo; por ejemplo, un paso de revisión.

Aunque no está directamente relacionada, la autorización del usuario debe tenerse en cuenta al asignar una acción; el usuario debe tener acceso a la página que es la carga útil del flujo de trabajo.

Etapa del participante: configuración

Para configurar el paso, edite y utilice las fichas siguientes:

• Común
• Usuario/grupo

Etapa de participante de cuadro de diálogo

Utilice un paso de participante en el cuadro de diálogo para recopilar información del usuario al que se ha asignado el elemento de trabajo. Este paso resulta ú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 nodos de la carga útil del flujo de trabajo. Los siguientes pasos 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

Para configurar el paso, edite y utilice las fichas siguientes:

• Común

• Usuario/grupo

• Cuadro de diálogo

  • Rutadel cuadro de diálogo: Ruta al nodo de cuadro de diálogo del cuadro de diálogo que cree.

Paso de participante en el cuadro de diálogo - Creación de un cuadro de diálogo

Para crear un cuadro de diálogo:

• Decida dónde se almacenarán los datos resultantes en la carga útil.
• Definir el cuadro de diálogo; esto incluye definir los campos utilizados para recopilar (y guardar) los datos.

Paso de participante en el cuadro de diálogo: almacenamiento de datos en la carga útil

Puede almacenar datos de utilidades en la carga útil del flujo de trabajo o en los metadatos del elemento de trabajo. El formato de la name propiedad del nodo de la utilidad determina dónde se almacenan los datos.

• Almacenar datos con la carga útil

  • Para almacenar datos de utilidades como propiedad de la carga útil del flujo de trabajo, utilice el siguiente formato para el valor de la propiedad name del nodo de la utilidad:

    ./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 posteriores 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 utilidades 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 nodename propiedad del elemento de trabajo metadata. Los datos se conservan si el cuadro de diálogo se utiliza posteriormente con la misma carga útil.

Etapa de participante del cuadro de diálogo: definición del cuadro de diálogo

1. Estructura de cuadro de diálogo

   Los cuadros de diálogo Pasos de los participantes son similares a los cuadros de diálogo que se crean para la creación de componentes. Se almacenan en:

   /apps/myapp/workflow/dialogs

   Los cuadros de diálogo para la IU estándar con capacidad táctil 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 de ruta de cuadro de diálogo

   El paso de participante en el cuadro de diálogo tiene la propiedad Ruta de diálogo (junto con las propiedades de un paso departicipante). El valor de la propiedad Dialog Path es la ruta al dialog nodo del cuadro de diálogo.

   Por ejemplo, el cuadro de diálogo está contenido en un componente denominado EmailWatch que está almacenado en el nodo:

   /apps/myapp/workflows/dialogs

   Para la IU táctil, se utiliza el siguiente valor para la propiedad Ruta de cuadro de diálogo:

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

   

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 String valor en el watchEmail nodo del contenido de la carga útil. El nodo title 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>
   

   En este ejemplo, en el caso de la IU táctil, se mostrará un cuadro de diálogo como:

   

Etapa de participante dinámica

El componente Etapa de participante dinámica es similar al 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ámico: configuración

Para configurar el paso, edite y utilice las fichas siguientes:

• Común

• Selector de participantes

  • Selector de participantes: 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 del cuadro de diálogo: Ruta al nodo de cuadro de diálogo del cuadro de diálogo que cree (como con el paso del participante del cuadro de diálogo).

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

Puede crear 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 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 devuelve un ID de usuario como String valor. Almacene los scripts personalizados, por ejemplo, en la /apps/myapp/workflow/scripts carpeta o en una subcarpeta.

  Se incluye una secuencia de comandos de ejemplo en una instancia de AEM estándar:

  /libs/workflow/scripts/initiator-participant-chooser.ecma

  PRECAUCIÓN

  No debe cambiar nada en la /libs ruta.

  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 revisió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 participantes del iniciador de flujo de trabajo amplía el paso de participante dinámico y utiliza esta secuencia de comandos 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 field: Utilice este campo para especificar el nombre del selector de participantes. El nombre aparece en una lista de los usuarios participantes disponibles en las propiedades de los pasos ​​dinámicos de los participantes.
  • getParticipant método: Devuelve la identificación principal resuelta dinámicamente como un String valor.
  PRECAUCIÓN

  El getParticipant método devuelve la identificación principal resuelta dinámicamente. Puede ser una identificación de grupo o de usuario.

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

  Para que la implementación esté disponible para los componentes de pasos de participante dinámico, agregue la clase Java a un paquete OSGi que exporte el servicio e implemente el paquete en el servidor de 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 del componente de paso Selector de participantes aleatorio amplía el paso de participante dinámico y utiliza este servicio como implementación de paso.

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

La siguiente clase Java implementa la 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 @Property anotación establece el valor del SERVICE_PROPERTY_LABEL campo 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 Propiedades de la etapa de participante dinámica, 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 a quién se le asigna el elemento de trabajo. En este ejemplo, el admin 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

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

Paso del participante en el formulario: configuración

Para configurar el paso, edite y utilice las fichas siguientes:

• Común

• Usuario/grupo

• Formulario

  • Ruta del formulario: Ruta al formulario que se crea.

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

Cree un formulario para utilizarlo normalmente con un paso de participante en el formulario. Sin embargo, los formularios para un paso de participante en el formulario deben tener las siguientes configuraciones:

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

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

• Los componentes del formulario deben tener la propiedad Nombre del elemento establecida en la ruta del nodo donde se almacenan los datos del campo. La ruta debe ubicar un nodo en el contenido de la carga útil del flujo de trabajo. El valor utiliza el siguiente formato:

  ./jcr:content/path_to_node

• El formulario debe incluir un componente Botón o botones de envío de flujo de trabajo . No se configura ninguna propiedad del componente.

Los requisitos del flujo de trabajo determinan dónde debe almacenar los datos de campo. Por ejemplo, los datos de campo pueden utilizarse para configurar las propiedades del contenido de la página. El siguiente valor de una propiedad Element Name almacena datos de campo como el valor de la redirectTarget propiedad del jcr:content nodo:

./jcr:content/redirectTarget

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

./jcr:content/par/text_3/text

"El primer ejemplo se puede utilizar para cualquier página que el cq:Page componente procese. El segundo ejemplo solo se puede utilizar cuando la página de carga útil incluye un componente Texto con un ID de text_3.

El formulario puede ubicarse en cualquier lugar del repositorio, pero los usuarios del flujo de trabajo deben estar autorizados para leerlo.

Selector de participante aleatorio

El paso Selector aleatorio de participantes es un selector de participantes que asigna el elemento de trabajo generado a un usuario seleccionado aleatoriamente desde una lista.

Selector de participante aleatorio: configuración

Para configurar el paso, edite y utilice las fichas siguientes:

• Común

• Argumentos

  • Participantes: Especifica la lista de usuarios disponibles para la selección. Para agregar un usuario a la lista, haga clic en Añadir elemento y escriba la ruta de acceso 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 participante de iniciador de flujo de trabajo

El paso Selector de participantes 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 otras propiedades que configurar que no sean las propiedades comunes .

Workflow Initiator Participant Chooser - Configuration

Para configurar el paso, edite con las fichas siguientes:

• Común

Etapa del proceso

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

Paso de proceso: configuración

Para configurar el paso, edite y utilice las fichas siguientes:

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

    • Los servicios estándar ECMAScripts y OSGi, consulte Procesos integrados para los pasosdel proceso.
    • Creación de ECMAScripts para un paso de proceso , consulte Implementación de un paso de proceso con un ECMAScript.
    • Creación de servicios OSGi para un paso de proceso , consulte Implementación de un paso de proceso con una claseJava.

  • 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 avance del flujo de trabajo.

  • Argumentos: Argumentos que se van a pasar al proceso.