Interagir avec les workflows par programmation interacting-with-workflows-programmatically

CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

When personnalisation et extension de vos workflows vous pouvez accéder aux objets de workflow :

Utilisation de l’API Java Workflow using-the-workflow-java-api

L’API Java Workflow se compose du package com.adobe.granite.workflow et de plusieurs sous-packages. L’élément le plus important de l’API est la classe com.adobe.granite.workflow.WorkflowSession. La classe WorkflowSession permet d’accéder aux objets de workflow au moment de la conception et de l’exécution :

  • modèles de workflow
  • éléments de travail
  • instances de workflow
  • données de workflow
  • éléments de boîte de réception

La classe fournit également plusieurs méthodes pour intervenir dans les cycles de vie des workflows.

Le tableau suivant fournit des liens vers la documentation de référence de plusieurs objets Java clés à utiliser lors de l’interaction par programmation avec des workflows. Les exemples suivants montrent comment obtenir et utiliser les objets de classe dans le code.

Fonctions
Objets
Accès à un workflow
WorkflowSession
Exécution et interrogation d’une instance de workflow
Workflow
WorkItem
WorkflowData
Gestion d’un modèle de workflow
WorkflowModel
WorkflowNode
WorkflowTransition
Informations relatives à un nœud qui se trouve (ou non) dans le workflow
WorkflowStatus

Obtention d’objets de workflow dans des scripts ECMA obtaining-workflow-objects-in-ecma-scripts

Comme indiqué dans la section Recherche du script, AEM (via Apache Sling) fournit un moteur de script ECMA qui exécute des scripts ECMA côté serveur. La classe org.apache.sling.scripting.core.ScriptHelper est mise immédiatement à la disposition de vos scripts en tant que variable sling.

La classe ScriptHelper permet d’accéder à l’objet SlingHttpServletRequest que vous pouvez utiliser pour obtenir finalement l’objet WorkflowSession ; par exemple :

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

Utilisation de l’API REST Workflow using-the-workflow-rest-api

La console Workflow fait un usage intensif de l’API REST ; cette page décrit donc l’API REST pour les workflows.

NOTE
L’outil de ligne de commande curl vous permet d’utiliser l’API REST Workflow pour accéder à des objets de workflow et gérer les cycles de vie d’une instance. Les exemples présentés dans cette page illustrent l'utilisation de l'API REST via l'outil de ligne de commande curl.

Les actions suivantes sont prises en charge avec l’API REST :

NOTE
En utilisant Firebug, une extension Firefox pour le développement web, il est possible de suivre le trafic HTTP lorsque la console est utilisée. Vous pouvez, par exemple, vérifier les paramètres et les valeurs envoyés au serveur AEM avec une requête POST.

Dans cette page, on part du principe qu’AEM s’exécute sur localhost sur le port 4502 et que le contexte d’installation est « / » (racine). Si ce n’est pas le cas de votre installation, les URI auxquelles les requêtes HTTP s’appliquent doivent être adaptées en conséquence.

Le rendu pris en charge pour les requêtes GET est de type JSON. Les URL relatives à GET doivent avoir l’extension .json ; par exemple :

http://localhost:4502/etc/workflow.json

Gestion des instances de workflow managing-workflow-instances

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/etc/workflow/instances

Méthode de requête HTTP
Actions
GET
Répertorie les instances de workflow disponibles.
POST
Crée une instance de workflow. Les paramètres sont les suivants :
- model : l’ID (URI) du modèle de workflow correspondant
- payloadType : contenant le type de payload (par exemple, JCR_PATH ou URL).
Le payload est envoyé en tant que paramètre payload. Une réponse 201 (CREATED) est renvoyée avec un en-tête d’emplacement contenant l’URL de la nouvelle instance de workflow.

Gestion d’une instance de workflow par son état managing-a-workflow-instance-by-its-state

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/etc/workflow/instances.{state}

Méthode de requête HTTP
Actions
GET
Répertorie les instances de workflow disponibles et leur statut (RUNNING, SUSPENDED, ABORTED ou COMPLETED).

Gestion d’une instance de workflow par son identifiant managing-a-workflow-instance-by-its-id

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/etc/workflow/instances/{id}

Méthode de requête HTTP
Actions
GET
Récupère les données des instances (définition et métadonnées), y compris le lien vers le modèle de workflow correspondant.
POST
Modifie le statut de l’instance. Le nouveau statut est envoyé en tant que paramètre state et doit avoir l’une des valeurs suivantes : RUNNING, SUSPENDED ou ABORTED.
Si le nouveau statut est inaccessible (par exemple, lors de l’interruption d’une instance terminée), une réponse 409 (CONFLICT) est renvoyée au client.

Gestion de modèles de workflow managing-workflow-models

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/etc/workflow/models

Méthode de requête HTTP
Actions
GET
Liste des modèles de workflow disponibles.
POST
Crée un modèle de workflow. Si le paramètre title est envoyé, un nouveau modèle est créé avec le titre spécifié. L’association d’un modèle JSON en tant que paramètre model crée un modèle de workflow en fonction de la définition fournie.
Une réponse 201 (CREATED) est renvoyée avec un en-tête d’emplacement contenant l’URL de la nouvelle ressource de modèle de workflow.
Cela se produit également lorsqu’une définition de modèle est associée en tant que paramètre de fichier appelé modelfile.
Pour les deux paramètres model et modelfile, un paramètre supplémentaire appelé type est nécessaire pour définir le format de sérialisation. De nouveaux formats de sérialisation peuvent être intégrés à l’aide de l’API OSGI. Un sérialiseur JSON standard est fourni avec le moteur de workflow. Son type est JSON. Voir ci-dessous un exemple du format.

Exemple : dans le navigateur, une requête adressée à http://localhost:4502/etc/workflow/models.json génère une réponse json semblable à ce qui suit :

[
    {"uri":"/var/workflow/models/activationmodel"}
    ,{"uri":"/var/workflow/models/dam/adddamsize"}
    ,{"uri":"/var/workflow/models/cloudconfigs/dtm-reactor/library-download"}
    ,{"uri":"/var/workflow/models/ac-newsletter-workflow-simple"}
    ,{"uri":"/var/workflow/models/dam/dam-create-language-copy"}
    ,{"uri":"/var/workflow/models/dam/dam-create-and-translate-language-copy"}
    ,{"uri":"/var/workflow/models/dam-indesign-proxy"}
    ,{"uri":"/var/workflow/models/dam-xmp-writeback"}
    ,{"uri":"/var/workflow/models/dam-parse-word-documents"}
    ,{"uri":"/var/workflow/models/dam/process_subasset"}
    ,{"uri":"/var/workflow/models/dam/dam_set_last_modified"}
    ,{"uri":"/var/workflow/models/dam/dam-autotag-assets"}
    ,{"uri":"/var/workflow/models/dam/update_asset"}
    ,{"uri":"/var/workflow/models/dam/update_asset_offloading"}
    ,{"uri":"/var/workflow/models/dam/dam-update-language-copy"}
    ,{"uri":"/var/workflow/models/dam/update_from_lightbox"}
    ,{"uri":"/var/workflow/models/cloudservices/DTM_bundle_download"}
    ,{"uri":"/var/workflow/models/dam/dam_download_asset"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-encode-video"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-thumbnail-replacement"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-user-uploaded-thumbnail"}
    ,{"uri":"/var/workflow/models/newsletter_bounce_check"}
    ,{"uri":"/var/workflow/models/projects/photo_shoot_submission"}
    ,{"uri":"/var/workflow/models/projects/product_photo_shoot"}
    ,{"uri":"/var/workflow/models/projects/approval_workflow"}
    ,{"uri":"/var/workflow/models/prototype-01"}
    ,{"uri":"/var/workflow/models/publish_example"}
    ,{"uri":"/var/workflow/models/publish_to_campaign"}
    ,{"uri":"/var/workflow/models/screens/publish_to_author_bin"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_publish_to_youtube"}
    ,{"uri":"/var/workflow/models/projects/request_copy"}
    ,{"uri":"/var/workflow/models/projects/request_email"}
    ,{"uri":"/var/workflow/models/projects/request_landing_page"}
    ,{"uri":"/var/workflow/models/projects/request_launch"}
    ,{"uri":"/var/workflow/models/request_for_activation"}
    ,{"uri":"/var/workflow/models/request_for_deactivation"}
    ,{"uri":"/var/workflow/models/request_for_deletion"}
    ,{"uri":"/var/workflow/models/request_for_deletion_without_deactivation"}
    ,{"uri":"/var/workflow/models/request_to_complete_move_operation"}
    ,{"uri":"/var/workflow/models/reverse_replication"}
    ,{"uri":"/var/workflow/models/salesforce-com-export"}
    ,{"uri":"/var/workflow/models/scene7"}
    ,{"uri":"/var/workflow/models/scheduled_activation"}
    ,{"uri":"/var/workflow/models/scheduled_deactivation"}
    ,{"uri":"/var/workflow/models/screens/screens-update-asset"}
    ,{"uri":"/var/workflow/models/translation"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_remove_from_youtube"}
    ,{"uri":"/var/workflow/models/wcm-translation/create_language_copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/prepare_translation_project"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-i18n-dictionary"}
    ,{"uri":"/var/workflow/models/wcm-translation/sync_translation_job"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-language-copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/update_language_copy"}
]

Gestion d’un modèle de workflow spécifique managing-a-specific-workflow-model

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502*{uri}*

*{uri}* est le chemin d’accès au nœud de modèle dans le référentiel.

Méthode de requête HTTP
Actions
GET
Obtient la version HEAD du modèle (définition et métadonnées).
PUT
Met à jour la version HEAD du modèle (crée une version).
La définition complète de modèle de la nouvelle version du modèle doit être ajoutée sous la forme d’un paramètre appelé model. En outre, un paramètre type est nécessaire, comme lors de la création de modèles, et doit être associé à la valeur JSON.
POST
Même comportement qu’avec PUT. Cette méthode est nécessaire car les widgets AEM ne prennent pas en charge les opérations PUT.
DELETE
Supprime le modèle. Pour résoudre les problèmes de pare-feu/proxy, un POST qui contient une entrée d’en-tête X-HTTP-Method-Override avec la valeur DELETE sera également accepté en tant que requête DELETE.

Exemple : dans le navigateur, une requête adressée à http://localhost:4502/var/workflow/models/publish_example.json renvoie une réponse json semblable au code suivant :

{
  "id":"/var/workflow/models/publish_example",
  "title":"Publish Example",
  "version":"1.0",
  "description":"This example shows a simple review and publish process.",
  "metaData":
  {
    "multiResourceSupport":"true",
    "tags":"wcm,publish"
  },
  "nodes":
  [{
    "id":"node0",
    "type":"START",
    "title":"Start",
    "description":"The start node of the workflow.",
    "metaData":
    {
    }
  },
  {
    "id":"node1",
    "type":"PARTICIPANT",
    "title":"Validate Content",
    "description":"Validate the modified content.",
    "metaData":
    {
      "PARTICIPANT":"admin"
    }
  },
  {
    "id":"node2",
    "type":"PROCESS",
    "title":"Publish Content",
    "description":"Publish the modified content.",
    "metaData":
    {
      "PROCESS_AUTO_ADVANCE":"true",
      "PROCESS":"com.day.cq.wcm.workflow.process.ActivatePageProcess"
    }
  },
  {
    "id":"node3",
    "type":"END",
    "title":"End",
    "description":"The end node of the workflow.",
    "metaData":
    {
    }
  }],
  "transitions":
  [{
    "from":"node0",
    "to":"node1",
    "metaData":
    {
    }
  },
  {
    "from":"node1",
    "to":"node2",
    "metaData":
    {
    }
  },
  {
    "from":"node2",
    "to":"node3",
    "metaData":
    {
    }
  }
]}

Gestion d’un modèle de workflow en fonction de sa version managing-a-workflow-model-by-its-version

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/etc/workflow/models/{id}.{version}

Méthode de requête HTTP
Actions
GET
Obtient les données du modèle dans la version donnée (le cas échéant).

Gestion de boîtes de réception (utilisateur) managing-user-inboxes

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/bin/workflow/inbox

Méthode de requête HTTP
Actions
GET
Répertorie les tâches qui se trouvent dans la boîte de réception de l’utilisateur, qui est identifié par les en-têtes d’authentification HTTP.
POST
Termine l’élément de travail dont l’URI est envoyé en tant que paramètre item et transmet l’instance de workflow correspondante aux nœuds suivants, en fonction de ce qui est défini par le paramètre route ou backroute, en cas de rétroaction.
Si le paramètre delegatee est envoyé, l’élément de travail identifié par le paramètre item est délégué au participant spécifié.

Gestion d’une boîte de réception (utilisateur) par l’identifiant de l’élément de travail managing-a-user-inbox-by-the-workitem-id

Les méthodes de requête HTTP suivantes s’appliquent à :

http://localhost:4502/bin/workflow/inbox/{id}

Méthode de requête HTTP
Actions
GET
Obtient les données (définition et métadonnées) du WorkItem de la boîte de réception identifié par son ID.

Exemples examples

Comment obtenir une liste de tous les workflows en cours d’exécution avec leurs ID how-to-get-a-list-of-all-running-workflows-with-their-ids

Pour obtenir la liste de tous les workflows en cours d’exécution, effectuez une GET pour :

http://localhost:4502/etc/workflow/instances.RUNNING.json

Comment obtenir une liste de tous les workflows en cours d’exécution avec leurs identifiants - REST à l’aide de curl how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Exemple avec curl :

curl -u admin:admin http://localhost:4502/etc/workflow/instances.RUNNING.json

L’uri affichée dans les résultats peut être utilisée comme id d’instance dans d’autres commandes. Par exemple :

[
    {"uri":"/etc/workflow/instances/server0/2017-03-08/request_for_activation_1"}
]
NOTE
Cette commande curl peut être utilisée avec n’importe quel statut de workflow à la place de RUNNING.

Comment modifier le titre du workflow how-to-change-the-workflow-title

Pour modifier le Titre du workflow affiché dans l’onglet Instances de la console Workflow, envoyez une commande POST :

  • vers : http://localhost:4502/etc/workflow/instances/{id}

  • avec les paramètres suivants :

    • action : sa valeur doit être UPDATE.
    • workflowTitle : titre du workflow

Comment modifier le titre du workflow - REST à l’aide de curl how-to-change-the-workflow-title-rest-using-curl

Exemple avec curl :

curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/{id}

# for example

>[!CAUTION]
>
>AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our [technical support periods](https://helpx.adobe.com/fr/support/programs/eol-matrix.html). Find the supported versions [here](https://experienceleague.adobe.com/docs/?lang=fr).
curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Comment répertorier tous les modèles de processus how-to-list-all-workflow-models

Pour obtenir la liste de tous les modèles de workflow disponibles, effectuez une GET pour :

http://localhost:4502/etc/workflow/models.json

Comment répertorier tous les modèles de processus - REST à l’aide de curl how-to-list-all-workflow-models-rest-using-curl

Exemple avec curl :

curl -u admin:admin http://localhost:4502/etc/workflow/models.json
NOTE
Consultez également la section Gestion de modèles de workflow.

Obtention d’un objet WorkflowSession obtaining-a-workflowsession-object

La classe com.adobe.granite.workflow.WorkflowSession peut être adaptée à partir d’un objet javax.jcr.Session ou org.apache.sling.api.resource.ResourceResolver.

Obtention d’un objet WorkflowSession – Java obtaining-a-workflowsession-object-java

Dans un script JSP (ou un code Java pour une classe servlet), utilisez l’objet de requête HTTP pour obtenir un objet SlingHttpServletRequest qui permet d’accéder à un objet ResourceResolver. Adaptez l’objet ResourceResolver en WorkflowSession.

<%
%><%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false"
    import="com.adobe.granite.workflow.WorkflowSession,
  org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
%>

Obtention d’un objet WorkflowSession – Script ECMA obtaining-a-workflowsession-object-ecma-script

Utilisez la variable sling pour récupérer l’objet SlingHttpServletRequest que vous utilisez pour obtenir un objet ResourceResolver. Adaptez l’objet ResourceResolver en objet WorkflowSession.

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

Création, lecture ou suppression de modèles de processus creating-reading-or-deleting-workflow-models

Les exemples suivants montrent comment accéder aux modèles de workflow :

  • Le code pour les scripts Java et ECMA utilise la méthode WorkflowSession.createNewModel.
  • La commande curl accède directement au modèle à l’aide de son URL.

Exemples utilisés :

  1. créent un modèle (avec l’ID /var/workflow/models/mymodel/jcr:content/model) ;
  2. suppriment le modèle.
NOTE
La suppression du modèle définit la propriété deleted du nœud enfant metaData du modèle sur true.
La suppression ne supprime pas le noeud de modèle.

Lors de la création d’un modèle :

  • L’éditeur de modèle de workflow exige que les modèles utilisent une structure de nœud spécifique sous /var/workflow/models. Le nœud parent du modèle doit être de type cq:Page avec un nœud jcr:content présentant les valeurs de propriété suivantes :

    • sling:resourceType: cq/workflow/components/pages/model
    • cq:template: /libs/cq/workflow/templates/model

    Lorsque vous créez un modèle, vous devez d’abord créer ce nœud cq:Page et utiliser son nœud jcr:content comme parent du nœud de modèle.

  • L’argument id requis par certaines méthodes pour identifier le modèle est le chemin d’accès absolu du modèle de nœud dans le référentiel :

    /var/workflow/models/<*model_name>*/jcr:content/model

    note note
    NOTE
    Consultez la section Comment répertorier tous les modèles de workflow.

Création, lecture ou suppression de modèles de workflow - Java creating-reading-or-deleting-workflow-models-java

<%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false" import="com.adobe.granite.workflow.WorkflowSession,
                 com.adobe.granite.workflow.model.WorkflowModel,
             org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
/* Create the parent page */
String modelRepo = new String("/var/workflow/models");
String modelTemplate = new String ("/libs/cq/workflow/templates/model");
String modelName = new String("mymodel");
Page modelParent = pageManager.create(modelRepo, modelName, modelTemplate, "My workflow model");

/* create the model */
String modelId = new String(modelParent.getPath()+"/jcr:content/model")
WorkflowModel model = wfSession.createNewModel("Made using Java",modelId);

/* delete the model */
wfSession.deleteModel(modelId);
%>

Création, lecture ou suppression de modèles de processus - Script ECMA creating-reading-or-deleting-workflow-models-ecma-script

var resolver = sling.getRequest().getResource().getResourceResolver();
var wfSession = resolver.adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);
var pageManager = resolver.adaptTo(Packages.com.day.cq.wcm.api.PageManager);

//create the parent page node
var workflowPage = pageManager.create("/var/workflow/models", "mymodel", "/libs/cq/workflow/templates/model", "Created via ECMA Script");
var modelId = workflowPage.getPath()+ "/jcr:content/model";
//create the model
var model = wfSession.createNewModel("My Model", modelId);
//delete the model
var model = wfSession.deleteModel(modelId);

Suppression d’un modèle de workflow - REST à l’aide de curl deleting-a-workflow-model-rest-using-curl

# deleting the model by its id

>[!CAUTION]
>
>AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our [technical support periods](https://helpx.adobe.com/fr/support/programs/eol-matrix.html). Find the supported versions [here](https://experienceleague.adobe.com/docs/?lang=fr).
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}
NOTE
En raison du niveau de détail requis, curl n’est pas considéré comme pratique pour créer et/ou lire un modèle.

Filtrage des workflows système lors de la vérification de l’état du workflow filtering-out-system-workflows-when-checking-workflow-status

Vous pouvez utiliser l’API WorkflowStatus pour récupérer des informations sur le statut des workflows d’un nœud.

Plusieurs méthodes sont associées au paramètre :

excludeSystemWorkflows

Ce paramètre peut être défini sur true pour indiquer que les workflows système doivent être exclus des résultats.

Vous pouvez mettre à jour la configuration OSGi Adobe Granite Workflow PayloadMapCache qui spécifie les Modelsmodèles de workflow à prendre en compte en tant que workflows système. Les modèles de workflow (d’exécution) par défaut sont les suivants :

  • /var/workflow/models/scheduled_activation/jcr:content/model
  • /var/workflow/models/scheduled_deactivation/jcr:content/model

Avance automatique de l’étape de participant après un dépassement de délai auto-advance-participant-step-after-a-timeout

Si vous devez avancer automatiquement une Participant étape qui n’a pas été effectuée dans un délai prédéfini, vous pouvez :

  1. Implémentez un écouteur d’événement OSGI pour écouter la création et la modification de tâches.

  2. Spécifiez un délai d’expiration (échéance), puis créez une tâche Sling planifiée pour qu’elle se déclenche à ce moment-là.

  3. Créez un gestionnaire de tâches qui est averti lors du dépassement du délai et qui déclenche la tâche.

    Ce gestionnaire exécutera l’action requise sur la tâche si cette dernière n’est pas encore terminée.

NOTE
Les mesures à prendre doivent être clairement définies pour pouvoir utiliser cette approche.

Interaction avec des instances de workflow interacting-with-workflow-instances

Vous trouverez ci-dessous des exemples de base sur la façon d’interagir (par programmation) avec des instances de workflow.

Interaction avec des instances de workflow – Java interacting-with-workflow-instances-java

// starting a workflow
WorkflowModel model = wfSession.getModel(workflowId);
WorkflowData wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
Workflow[] workflows workflows = wfSession.getAllWorkflows();
Workflow workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

Interaction avec des instances de workflow – Script ECMA interacting-with-workflow-instances-ecma-script

// starting a workflow
var model = wfSession.getModel(workflowId);
var wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
var workflows = wfSession.getWorkflows(“RUNNING“);
var workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

Interaction avec des instances de workflow – REST avec curl interacting-with-workflow-instances-rest-using-curl

  • Démarrage d’un workflow

    code language-shell
    # starting a workflow
    curl -d "model={id}&payloadType={type}&payload={payload}" http://localhost:4502/etc/workflow/instances
    
    # for example:
    curl -u admin:admin -d "model=/var/workflow/models/request_for_activation&payloadType=JCR_PATH&payload=/content/we-retail/us/en/products" http://localhost:4502/etc/workflow/instances
    
  • Liste des instances

    code language-shell
    # listing the instances
    curl -u admin:admin http://localhost:4502/etc/workflow/instances.json
    

    Cela liste toutes les instances ; par exemple :

    code language-shell
    [
        {"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_1"}
        ,{"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_2"}
    ]
    
    note note
    NOTE
    Consultez la section Comment obtenir la liste de tous les workflow actifs avec leurs ID pour répertorier les instances qui présentent un statut spécifique.
  • Suspension d'un workflow

    code language-shell
    # suspending a workflow
    curl -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/{id}
    
    # for example:
    curl -u admin:admin -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1
    
  • Reprise d’un workflow

    code language-shell
    # resuming a workflow
    curl -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/{id}
    
    # for example:
    curl -u admin:admin -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1
    
  • Arrêt d’une instance de workflow

    code language-shell
    # terminating a workflow
    curl -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/{id}
    
    # for example:
    curl -u admin:admin -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1
    

Interaction avec des éléments de travail interacting-with-work-items

Vous trouverez ci-dessous des exemples de base sur la manière d’interagir (par programmation) avec des tâches.

Interaction avec les éléments de travail - Java interacting-with-work-items-java

// querying work items
WorkItem[] workItems = wfSession.getActiveWorkItems();
WorkItem workItem = wfSession.getWorkItem(id);

// getting routes
List<Route> routes = wfSession.getRoutes(workItem);

// delegating
Iterator<Participant> delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

Interaction avec des éléments de travail - Script ECMA interacting-with-work-items-ecma-script

// querying work items
var workItems = wfSession.getActiveWorkItems();
var workItem = wfSession.getWorkItem(id);

// getting routes
var routes = wfSession.getRoutes(workItem);

// delegating
var delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

Interaction avec des éléments de travail - REST à l’aide de curl interacting-with-work-items-rest-using-curl

  • Liste des éléments de travail de la boîte de réception

    code language-shell
    # listing the work items
    curl -u admin:admin http://localhost:4502/bin/workflow/inbox
    

    Les détails des tâches actuellement présentes dans la boîte de réception sont répertoriés. par exemple :

    code language-shell
    [{
        "uri_xss": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
        "uri": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
        "currentAssignee_xss": "workflow-administrators",
        "currentAssignee": "workflow-administrators",
        "startTime": 1519656289274,
        "payloadType_xss": "JCR_PATH",
        "payloadType": "JCR_PATH",
        "payload_xss": "/content/we-retail/es/es",
        "payload": "/content/we-retail/es/es",
        "comment_xss": "Process resource is null",
        "comment": "Process resource is null",
        "type_xss": "WorkItem",
        "type": "WorkItem"
      },{
        "uri_xss": "configuration/configure_analyticstargeting",
        "uri": "configuration/configure_analyticstargeting",
        "currentAssignee_xss": "administrators",
        "currentAssignee": "administrators",
        "type_xss": "Task",
        "type": "Task"
      },{
        "uri_xss": "configuration/securitychecklist",
        "uri": "configuration/securitychecklist",
        "currentAssignee_xss": "administrators",
        "currentAssignee": "administrators",
        "type_xss": "Task",
        "type": "Task"
      },{
        "uri_xss": "configuration/enable_collectionofanonymoususagedata",
        "uri": "configuration/enable_collectionofanonymoususagedata",
        "currentAssignee_xss": "administrators",
        "currentAssignee": "administrators",
        "type_xss": "Task",
        "type": "Task"
      },{
        "uri_xss": "configuration/configuressl",
        "uri": "configuration/configuressl",
        "currentAssignee_xss": "administrators",
        "currentAssignee": "administrators",
        "type_xss": "Task",
        "type": "Task"
      }
    
  • Délégation d’éléments de travail

    code language-xml
    # delegating
    curl -d "item={item}&delegatee={delegatee}" http://localhost:4502/bin/workflow/inbox
    
    # for example:
    curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_act_1&delegatee=administrators" http://localhost:4502/bin/workflow/inbox
    
    note note
    NOTE
    Le delegatee doit être une option valide pour l’étape de workflow.
  • Réalisation ou progression d’éléments de travail jusqu’à l’étape suivante

    code language-xml
    # retrieve the list of routes; the results will be similar to {"results":1,"routes":[{"rid":"233123169","label":"End","label_xss":"End"}]}
    http://localhost:4502/etc/workflow/instances/<path-to-the-workitem>.routes.json
    
    # completing or advancing to the next step; use the appropriate route ID (rid value) from the above list
    curl -d "item={item}&route={route}" http://localhost:4502/bin/workflow/inbox
    
    # for example:
    curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_activation_1&route=233123169" http://localhost:4502/bin/workflow/inbox
    

Écoute des événements de workflow listening-for-workflow-events

Utilisez le framework d’événement OSGi pour écouter les événements définis par la classe com.adobe.granite.workflow.event.WorkflowEvent. Cette classe propose également plusieurs méthodes utiles pour obtenir des informations sur le sujet de l’événement. La méthode getWorkItem, par exemple, renvoie l’objet WorkItem de l’élément de travail qui est impliqué dans l’événement.

L’exemple de code suivant définit un service qui écoute les événements de workflow et exécute les tâches selon le type d’événement.

package com.adobe.example.workflow.listeners;

import org.apache.sling.event.jobs.JobProcessor;
import org.apache.sling.event.jobs.JobUtil;

import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;

import com.adobe.granite.workflow.event.WorkflowEvent;
import com.adobe.granite.workflow.exec.WorkItem;

/**
 * The <code>WorkflowEventCatcher</code> class listens to workflow events.
 */
@Component(metatype=false, immediate=true)
@Service(value=org.osgi.service.event.EventHandler.class)
public class WorkflowEventCatcher implements EventHandler, JobProcessor {

 @Property(value=com.adobe.granite.workflow.event.WorkflowEvent.EVENT_TOPIC)
 static final String EVENT_TOPICS = "event.topics";

 private static final Logger logger = LoggerFactory.getLogger(WorkflowEventCatcher.class);

 public void handleEvent(Event event) {
  JobUtil.processJob(event, this);
 }

 public boolean process(Event event) {
  logger.info("Received event of topic: " + event.getTopic());
  String topic = event.getTopic();

  try {
   if (topic.equals(WorkflowEvent.EVENT_TOPIC)) {
    WorkflowEvent wfevent = (WorkflowEvent)event;
    String eventType = wfevent.getEventType();
    String instanceId = wfevent.getWorkflowInstanceId();

    if (instanceId != null) {
     //workflow instance events
     if (eventType.equals(WorkflowEvent.WORKFLOW_STARTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_RESUMED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_SUSPENDED_EVENT)) {
      // your code comes here...
     } else if (
       eventType.equals(WorkflowEvent.WORKFLOW_ABORTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_COMPLETED_EVENT)) {
      // your code comes here...
     }
     // workflow node event
     if (eventType.equals(WorkflowEvent.NODE_TRANSITION_EVENT)) {
      WorkItem currentItem = (WorkItem) event.getProperty(WorkflowEvent.WORK_ITEM);
      // your code comes here...
     }
    }
   }
  } catch(Exception e){
   logger.debug(e.getMessage());
   e.printStackTrace();
  }
  return true;
 }
}
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e