Référence sur les étapes de workflow workflow-step-reference

Les modèles de workflow se composent d’une série d’étapes de différents types. En fonction du type, ces étapes peuvent être configurées et étendues avec des paramètres et des scripts afin de fournir les fonctionnalités et le contrôle dont vous avez besoin.

Propriétés des étapes step-properties

Chaque composant d’étape comporte une boîte de dialogue Propriétés de l’étape qui vous permet de définir et de modifier les propriétés requises.

Propriétés des étapes - Onglet courant step-properties-common-tab

Une combinaison des propriétés suivantes est disponible pour la plupart des composants d’étape de workflow, sur l’onglet Courant de la boîte de dialogue des propriétés :

Propriétés des étapes - Onglet utilisateur/groupe step-properties-user-group-tab

Les propriétés suivantes sont disponibles pour de nombreux composants d’étape de workflow, dans l’onglet Utilisateur/Groupe de la boîte de dialogue des propriétés :

Division ET and-split

La Division ET crée une division dans le workflow, après laquelle les deux branches deviennent actives. Vous ajoutez des étapes de workflow à chaque branche selon vos besoins. Cette étape vous permet d’ajouter plusieurs chemins de traitement dans le workflow. Par exemple, vous pouvez autoriser certaines étapes de révision à se produire en parallèle, ce qui vous permet de gagner du temps.

Division ET - Configuration and-split-configuration

Pour configurer la division :

Étape du conteneur container-step

Une étape de conteneur lance un autre modèle de workflow qui s’exécute en tant que workflow enfant.

Ce conteneur peut vous permettre de réutiliser des modèles de workflow pour implémenter des séquences d’étapes courantes. Par exemple, un modèle de processus de traduction peut être utilisé dans plusieurs workflows de modification.

Étape du conteneur - Configuration container-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Etape Atteindre goto-step

L’Étape Goto vous permet de spécifier l’étape suivante à exécuter dans le modèle de workflow. Vous pouvez spécifier une définition de règle, un script externe ou un script ECMA comme expression de routage pour évaluer l’étape suivante du modèle de workflow.

L’Étape Goto vous permet de mettre en œuvre des structures de routage avancées dans vos modèles de workflow. Par exemple, pour mettre en œuvre une boucle, l’Étape Goto peut être définie pour exécuter une étape antérieure dans le workflow, avec le script évaluant une condition de boucle.

Etape Atteindre - Configuration goto-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Simulation d’une « boucle for » simulating-a-for-loop

Pour simuler une « boucle for », vous devez compter le nombre d’itérations de boucle qui se sont produites :

Par exemple, pour implémenter un workflow qui exécute une action sur plusieurs nœuds JCR, vous pouvez utiliser un compteur de boucles comme index pour les nœuds. Pour rendre le compte persistant, stockez une valeur integer dans le mappage de données de l’instance de workflow. Pour incrémenter le compte et comparer ce compte aux critères de sortie, utilisez le script de l’étape Atteindre.

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

Simulation d’une boucle for à l’aide la définition de règle simulateforloop

Vous pouvez également simuler une boucle for à l’aide de la définition de règle comme expression de routage. Créez une variable countde type de données Long. Utilisez Expression comme mode de mappage dans l’étape Définir la variable pour définir la valeur de la variable count sur count + 1 à chaque exécution de l’étape Définir la variable.

Dans l’Étape Goto, utilisez Définir la variable comme Étape cible et count < 5 comme expression de routage.

L’étape Définir la variable s’exécute à plusieurs reprises pour incrémenter la valeur de la variable Compte de 1 pour chaque exécution, jusqu’à ce que la valeur atteigne 5.

Division OU or-split

La Division OU crée une division dans le workflow, après laquelle une seule branche est active. Cette étape permet d’ajouter des chemins de traitement conditionnels dans le processus. Vous ajoutez des étapes de processus à chaque branche selon vos besoins.

Division OU - Configuration or-split-configuration

Pour configurer la division :

Programme et étapes de sélection des participants participant-steps-and-choosers

Étape du participant participant-step

L’Étape du participant vous permet d’attribuer la responsabilité d’une action spécifique. Pour que le workflow se poursuive, l’utilisateur ou l’utilisatrice doit valider manuellement l’étape. Ce workflow permet qu’une personne agisse sur un workflow. Par exemple, une étape de révision.

Notez également que l’utilisatrice ou l’utilisateur doit disposer des autorisations nécessaires lors de l’attribution d’une action. Celle-ci doit avoir accès à la page qui est la payload du workflow.

Étape du participant - Configuration participant-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Étape du participant de la boîte de dialogue dialog-participant-step

Utilisez l’Étape des participants de la boîte de dialogue pour collecter des informations auprès de l’utilisateur ou utilisatrice auquel l’élément de travail a été attribué. Cette étape est utile pour collecter de petites quantités de données utilisées plus loin dans le workflow.

Une fois l’étape terminée, la boîte de dialogue Terminer l’élément de travail contient les champs définis dans votre boîte de dialogue. Les données collectées dans les champs sont stockées dans les nœuds de la charge utile du workflow. Les étapes suivantes du workflow peuvent alors lire la valeur dans le référentiel.

Pour configurer l’étape, indiquez le groupe ou l’utilisateur ou utilisatrice affecté à l’élément de travail, ainsi que le chemin d’accès à la boîte de dialogue.

Étape des participants de la boîte de dialogue - Configuration dialog-participant-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Étape des participants de la boîte de dialogue - Créer une boîte de dialogue dialog-participant-step-creating-a-dialog

Pour créer une boîte de dialogue, vous devez :

Étape des participants de la boîte de dialogue - Stockage des données dans la payload dialog-participant-step-storing-data-in-the-payload

Vous pouvez stocker des données de widget dans la payload du workflow ou dans les métadonnées de l’élément de travail. Le format de la propriété name du nœud de widget détermine l’endroit où les données sont stockées.

Étape des participants de la boîte de dialogue - Définition de boîte de dialogue dialog-participant-step-dialog-definition

Étape du participant dynamique dynamic-participant-step

Le composant Étape du participant dynamique est similaire à l’étape du participant, à la différence que la sélection du participant ou de la participante s’effectue automtiquement au moment de l’exécution.

Pour configurer l’étape, sélectionnez un Programme de sélection des participants qui identifie les participants auxquels affecter l’élément de travail, ainsi qu’une boîte de dialogue.

Étape du participant dynamique - Configuration dynamic-participant-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Étape du participant dynamique - Développement du programme de sélection des participants dynamic-participant-step-developing-the-participant-chooser

Vous créez le programme de sélection des participants. Par conséquent, vous pouvez utiliser n’importe quel critère ou logique de sélection. Par exemple, votre programme de sélection des participants peut sélectionner l’utilisateur ou l’utilisatrice (au sein d’un groupe) qui a le moins d’éléments de travail. Vous pouvez créer un nombre illimité de programmes de sélection des participants à utiliser avec différentes instances de l’Étape du participant dynamique dans vos modèles de workflow.

Créez un service OSGi ou un ECMAScript qui sélectionne les utilisateurs auxquels affecter l’élément de travail.

Étape du participant dynamique – Exemple de service de sélection de participant dynamic-participant-step-example-participant-chooser-service

La classe Java™ suivante met en œuvre l’interface ParticipantStepChooser. La classe renvoie le nom du participant qui a initié le workflow. Le code utilise la même logique que l’exemple de script (initiator-participant-chooser.ecma).

L’annotation @Property définit la valeur du champ SERVICE_PROPERTY_LABEL sur 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;
 }
}

Dans la boîte de dialogue des propriétés d’Étape de participant dynamique, la liste Programme de sélection des participants inclut l’élément Workflow Initiator Participant Chooser (script), qui représente ce service.

Lorsque le modèle de workflow est démarré, le journal indique l’ID de l’utilisateur qui a initié le workflow et qui se voit attribuer l’élément de travail. Dans cet exemple, l’utilisateur admin a lancé le workflow.

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

Étape du participant au formulaire form-participant-step

L’étape de participant du formulaire présente un formulaire lorsque l’élément de travail est ouvert. Lorsque les utilisateurs remplissent et envoient le formulaire, les données de champ sont stockées dans les nœuds de la payload du workflow.

Pour configurer l’étape, vous spécifiez le groupe, l’utilisateur ou l’utilisatrice auquel affecter l’élément de travail et le chemin d’accès au formulaire.

Étape du participant au formulaire – Configuration form-participant-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Étape du participant au formulaire – Création du formulaire form-participant-step-creating-the-form

Créez un formulaire à utiliser avec une étape de participant du formulaire de façon normale. Toutefois, les formulaires d’une étape du participant au formulaire doivent présenter les configurations suivantes :

Les exigences de votre workflow déterminent où stocker les données de champ. Par exemple, les données de champ peuvent être utilisées pour configurer les propriétés du contenu de la page. La valeur suivante d’une propriété Nom de l’élément stocke les données de champs comme valeur de la propriété redirectTarget du nœud jcr:content :

./jcr:content/redirectTarget

Dans l’exemple suivant, les données de champs sont utilisées en tant que contenu d’un composant Texte sur la page du payload :

./jcr:content/par/text_3/text

Le premier exemple peut être utilisé pour toute page dont le rendu est effectué par le composant cq:Page. Le second exemple peut uniquement être utilisé lorsque la page du payload inclut un composant Texte possédant l’ID text_3.

Le formulaire peut se trouver n’importe où dans le référentiel, mais les utilisateurs et utilisatrices du workflow doivent être autorisé(e)s à lire le formulaire.

Programme de sélection aléatoire des participants random-participant-chooser

L’étape Programme de sélection aléatoire des participants est un programme de sélection des participants qui attribue l’élément de travail généré à un utilisateur qui est choisi de manière aléatoire à partir d’une liste.

Programme de sélection aléatoire des participants - Configuration random-participant-chooser-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Programme de sélection des participants à l’initiateur de workflow workflow-initiator-participant-chooser

L’étape du programme de sélection des participants à l’initiateur de workflow est un programme de sélection des participants qui affecte la tâche générée à l’utilisateur ou utilisatrice qui a lancé le workflow. Il n’existe aucune autre propriété à configurer, à part les propriétés courantes.

Programme de sélection des participants à l’initiateur de workflow - Configuration workflow-initiator-participant-chooser-configuration

Pour configurer l’étape, effectuez les modifications à l’aide des onglets suivants :

Étape du processus process-step

Une étape du processus exécute un ECMAScript ou appelle un service OSGi pour effectuer un traitement automatique.

Étape du processus - Configuration process-step-configuration

Pour configurer l’étape, modifiez et utilisez les onglets suivants :

Définition d’une variable set-variable

Vous pouvez utiliser l’étape « Définir une variable » pour définir la valeur d’une variable et l’ordre de définition des valeurs. La variable est définie dans l’ordre dans lequel les mappages de variables sont répertoriés à l’étape Définir une variable.

Définition d’une variable - Configuration setvariable

Pour configurer l’étape, modifiez et utilisez les onglets suivants :