Interactuar con flujos de trabajo mediante programación

Última actualización: 15 de julio de 2024

Se aplica a:
Experience Manager 6.5

Temas:
Desarrollo

Creado para:

Desarrollador

Al personalizar y ampliar sus flujos de trabajo, puede acceder a los objetos de flujo de trabajo:

Uso de la API de Java de flujo de trabajo
Obtención de objetos de flujo de trabajo en scripts ECMA
Uso de la API de REST de flujo de trabajo

Uso de la API de Java de flujo de trabajo

La API de Java del flujo de trabajo consta del paquete com.adobe.granite.workflow y varios subpaquetes. El miembro más significativo de la API es la clase com.adobe.granite.workflow.WorkflowSession. La clase WorkflowSession proporciona acceso a los objetos de flujo de trabajo en tiempo de diseño y en tiempo de ejecución:

modelos de flujo de trabajo
elementos de trabajo
instancias de flujo de trabajo
datos de flujo de trabajo
elementos de bandeja de entrada

La clase también proporciona varios métodos para intervenir en los ciclos de vida del flujo de trabajo.

En la tabla siguiente se proporcionan vínculos a la documentación de referencia de varios objetos Java clave que se pueden utilizar al interactuar mediante programación con flujos de trabajo. En los ejemplos siguientes se muestra cómo obtener y utilizar los objetos de clase en el código.

Características

Objetos

Acceso a un flujo de trabajo

WorkflowSession

Ejecución y consulta de una instancia de flujo de trabajo

Workflow
WorkItem
WorkflowData

Administración de un modelo de flujo de trabajo

WorkflowModel
WorkflowNode
WorkflowTransition

Información para un nodo que está en el flujo de trabajo (o no)

WorkflowStatus

Obtención de objetos de flujo de trabajo en scripts ECMA

AEM Tal como se describe en Localización del script, el servicio de scripts (a través de Apache Sling) proporciona un motor de scripts ECMA que ejecuta scripts ECMA del lado del servidor. La clase org.apache.sling.scripting.core.ScriptHelper está disponible inmediatamente para los scripts como la variable sling.

La clase ScriptHelper proporciona acceso a SlingHttpServletRequest que puede utilizar para obtener finalmente el objeto WorkflowSession; por ejemplo:

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

Uso de la API de REST de flujo de trabajo

La consola de flujo de trabajo utiliza en gran medida la API de REST, por lo que esta página describe la API de REST para los flujos de trabajo.

NOTE

La herramienta de línea de comandos curl permite utilizar la API de REST de flujo de trabajo para acceder a los objetos de flujo de trabajo y administrar los ciclos de vida de las instancias. Los ejemplos de esta página muestran el uso de la API de REST a través de la herramienta de línea de comandos curl.

La API de REST admite las siguientes acciones:

inicio o detención de un servicio de flujo de trabajo
crear, actualizar o eliminar modelos de flujo de trabajo
iniciar, suspender, reanudar o finalizar instancias de flujo de trabajo
completar o delegar elementos de trabajo

NOTE

Al utilizar Firebug, una extensión de Firefox para el desarrollo web, es posible seguir el tráfico HTTP cuando se opera la consola. AEM Por ejemplo, puede comprobar los parámetros y los valores enviados al servidor de la con una solicitud POST.

AEM En esta página se supone que se ejecuta en el host local en el puerto 4502 y que el contexto de instalación es " /" (raíz). Si no es el caso de su instalación, los URI, a los que se aplican las solicitudes HTTP, deben adaptarse en consecuencia.

El procesamiento admitido para GET solicitudes es el procesamiento JSON. Las direcciones URL de GET deben tener la extensión .json, por ejemplo:

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

Administración de instancias de flujo de trabajo

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Muestra las instancias de flujo de trabajo disponibles.

POST

Crea una nueva instancia de flujo de trabajo. Los parámetros son:
- model: el identificador (URI) del modelo de flujo de trabajo respectivo
- payloadType: que contiene el tipo de carga útil (por ejemplo, JCR_PATH o URL).
: la carga útil se envía como parámetro payload. Se devuelve una respuesta 201 (CREATED) con un encabezado de ubicación que contiene la dirección URL del nuevo recurso de instancia de flujo de trabajo.

Administración de una instancia de flujo de trabajo por su estado

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Muestra las instancias de flujo de trabajo disponibles y sus estados ( RUNNING, SUSPENDED, ABORTED o COMPLETED)

Administración de una instancia de flujo de trabajo por su ID

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Obtiene los datos de instancias (definición y metadatos), incluido el vínculo al modelo de flujo de trabajo correspondiente.

POST

Cambia el estado de la instancia. El nuevo estado se envía como parámetro state y debe tener uno de los siguientes valores: RUNNING, SUSPENDED o ABORTED.
Si no se puede tener acceso al nuevo estado (por ejemplo, al suspender una instancia terminada), se devuelve una respuesta 409 (CONFLICT) al cliente.

Administrar modelos de flujo de trabajo

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Muestra los modelos de flujo de trabajo disponibles.

POST

Crea un nuevo modelo de flujo de trabajo. Si se envía el parámetro title, se crea un nuevo modelo con el título especificado. Al adjuntar una definición de modelo JSON como parámetro model, se crea un nuevo modelo de flujo de trabajo de acuerdo con la definición proporcionada.
: se devuelve una respuesta 201 (CREATED) con un encabezado de ubicación que contiene la dirección URL del nuevo recurso de modelo de flujo de trabajo.
Lo mismo ocurre cuando se adjunta una definición de modelo como parámetro de archivo denominado modelfile.
En ambos casos de los parámetros model y modelfile, se requiere un parámetro adicional denominado type para definir el formato de serialización. Se pueden integrar nuevos formatos de serialización mediante la API OSGI. Se entrega un serializador JSON estándar con el motor de flujo de trabajo. Su tipo es JSON. Consulte a continuación un ejemplo del formato.

Ejemplo: en el explorador, una solicitud a http://localhost:4502/etc/workflow/models.json genera una respuesta json similar a la siguiente:

[
    {"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"}
]

Administración de un modelo de flujo de trabajo específico

Los siguientes métodos de solicitud HTTP se aplican a:

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

Donde *{uri}* es la ruta al nodo del modelo en el repositorio.

método de petición HTTP

Acciones

GET

Obtiene la versión HEAD del modelo (definición y metadatos).

PUT

Actualiza la versión HEAD del modelo (crea una nueva versión).
: la definición completa del modelo para la nueva versión del modelo debe agregarse como parámetro denominado model. Además, se necesita un parámetro type, ya que al crear nuevos modelos necesita tener el valor JSON.

POST

Igual que con el PUT. AEM Necesario porque los widgets de la no admiten operaciones de PUT.

DELETE

Elimina el modelo. Para resolver los problemas de servidor de seguridad o proxy, también se aceptará como solicitud DELETE un POST que contenga una entrada de encabezado X-HTTP-Method-Override con el valor DELETE.

Ejemplo: en el explorador, una solicitud a http://localhost:4502/var/workflow/models/publish_example.json devuelve una respuesta json similar al siguiente código:

{
  "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":
    {
    }
  }
]}

Administrar un modelo de flujo de trabajo por su versión

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Obtiene los datos del modelo en la versión dada (si existe).

Administración de bandejas de entrada (de usuario)

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Enumera los elementos de trabajo que se encuentran en la bandeja de entrada del usuario, que se identifica mediante los encabezados de autenticación HTTP.

POST

Completa el elemento de trabajo cuyo URI se envía como parámetro item y avanza la instancia de flujo de trabajo correspondiente a los siguientes nodos, definidos por el parámetro route o backroute si hay un paso atrás.
Si se envía el parámetro delegatee, el elemento de trabajo identificado por el parámetro item se delega al participante especificado.

Administración de una bandeja de entrada (de usuario) mediante el ID de elemento de trabajo

Los siguientes métodos de solicitud HTTP se aplican a:

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

método de petición HTTP

Acciones

GET

Obtiene los datos (definición y metadatos) de la bandeja de entrada WorkItem identificados por su id.

Ejemplos

Obtención de una lista de todos los flujos de trabajo en ejecución con sus ID

Para obtener una lista de todos los flujos de trabajo en ejecución, haga una GET a:

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

Cómo obtener una lista de todos los flujos de trabajo en ejecución con sus ID: REST mediante curl

Ejemplo con curl:

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

El uri mostrado en los resultados se puede usar como instancia id en otros comandos; por ejemplo:

[
    {"uri":"/etc/workflow/instances/server0/2017-03-08/request_for_activation_1"}
]

NOTE

Este comando curl se puede usar con cualquier estado del flujo de trabajo en lugar de RUNNING.

Cómo cambiar el título del flujo de trabajo

Para cambiar el Título del flujo de trabajo mostrado en la ficha Instancias de la consola de flujo de trabajo, envíe un comando POST:

hasta: http://localhost:4502/etc/workflow/instances/{id}
con los siguientes parámetros:
- action: su valor debe ser: UPDATE
- workflowTitle: el título del flujo de trabajo

Cómo cambiar el Título del flujo de trabajo - REST mediante curl

Ejemplo con curl:

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

# for example
curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Cómo enumerar todos los modelos de flujo de trabajo

Para obtener una lista de todos los modelos de flujo de trabajo disponibles, haga una GET a:

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

Cómo enumerar todos los modelos de flujo de trabajo: REST mediante curl

Ejemplo con curl:

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

NOTE

Consulte también Administración de modelos de flujo de trabajo.

Obtención de un objeto WorkflowSession

La clase com.adobe.granite.workflow.WorkflowSession es adaptable desde un objeto javax.jcr.Session o un objeto org.apache.sling.api.resource.ResourceResolver.

Obtención de un objeto WorkflowSession - Java

En un script JSP (o código Java para una clase de servlet), utilice el objeto de solicitud HTTP para obtener un objeto SlingHttpServletRequest, que proporciona acceso a un objeto ResourceResolver. Adaptar el objeto ResourceResolver a 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);
%>

Obtención de un objeto WorkflowSession: script ECMA

Utilice la variable sling para obtener el objeto SlingHttpServletRequest que utiliza para obtener un objeto ResourceResolver. Adaptar el objeto ResourceResolver al objeto WorkflowSession.

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

Creación, lectura o eliminación de modelos de flujo de trabajo

Los siguientes ejemplos muestran cómo acceder a los modelos de flujo de trabajo:

El código para Java y el script ECMA utiliza el método WorkflowSession.createNewModel.
El comando curl accede al modelo directamente mediante su dirección URL.

Los ejemplos utilizados son:

Cree un modelo (con el ID /var/workflow/models/mymodel/jcr:content/model).
Elimine el modelo.

NOTE

Al eliminar el modelo, se establece la propiedad deleted del nodo secundario metaData del modelo en true.

La eliminación no elimina el nodo del modelo.

Al crear un modelo:

El editor del modelo de flujo de trabajo requiere que los modelos utilicen una estructura de nodos específica debajo de /var/workflow/models. El nodo primario del modelo debe ser del tipo cq:Page, que tiene un nodo jcr:content con los siguientes valores de propiedad:
- sling:resourceType: cq/workflow/components/pages/model
- cq:template: /libs/cq/workflow/templates/model
Cuando cree un modelo, primero debe crear este nodo cq:Page y usar su nodo jcr:content como el nodo principal del nodo del modelo.
El argumento id que algunos métodos requieren para identificar el modelo es la ruta absoluta del nodo del modelo en el repositorio:

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

NOTE
Ver Cómo enumerar todos los modelos de flujo de trabajo.

Creación, lectura o eliminación de modelos de flujo de trabajo: 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);
%>

Creación, lectura o eliminación de modelos de flujo de trabajo: script ECMA

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

Eliminación de un modelo de flujo de trabajo: REST mediante curl

# deleting the model by its id
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}

NOTE

Debido al nivel de detalle requerido, el curl no se considera práctico para crear y/o leer un modelo.

Filtrado de flujos de trabajo del sistema al comprobar el estado del flujo de trabajo

Puede usar la API WorkflowStatus para recuperar información sobre el estado del flujo de trabajo de un nodo.

Varios métodos tienen el parámetro:

excludeSystemWorkflows

Este parámetro se puede establecer en true para indicar que los flujos de trabajo del sistema deben excluirse de los resultados relevantes.

Usted puede actualizar la configuración de OSGi Adobe Granite Workflow PayloadMapCache que especifica que el flujo de trabajo Models se considere como flujos de trabajo del sistema. Los modelos predeterminados (de tiempo de ejecución) del flujo de trabajo son:

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

Paso de participante de avance automático después de un tiempo de espera

Si necesita avanzar automáticamente un paso de Participante que no se haya completado en un tiempo predefinido, puede:

Implemente un detector de eventos OSGI para escuchar la creación y modificación de tareas.
Especifique un tiempo de espera (fecha límite) y, a continuación, cree un trabajo de sling programado para activarse en ese momento.
Escriba un controlador de trabajo al que se notifique cuando caduque el tiempo de espera y déclencheur el trabajo.

Este controlador realizará la acción necesaria en la tarea si esta aún no se ha completado

NOTE

Las medidas que se adopten deben estar claramente definidas para poder utilizar este enfoque.

Interactuar con instancias de flujo de trabajo

A continuación se proporcionan ejemplos básicos de cómo interactuar (mediante programación) con instancias de flujo de trabajo.

Interactuar con instancias de flujo de trabajo: 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);

Interactuar con instancias de flujo de trabajo: script ECMA

// 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);

Interactuar con instancias de flujo de trabajo: REST mediante curl

Iniciando un flujo de trabajo

# 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

Enumerando las instancias

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

Esto enumerará todas las instancias; por ejemplo:

[
    {"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_1"}
    ,{"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_2"}
]

NOTE

Ver Cómo obtener una lista de todos los flujos de trabajo en ejecución con sus identificadores para enumerar instancias con un estado específico.

Suspendiendo un flujo de trabajo

# 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

Reanudando un flujo de trabajo

# 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

Finalizando una instancia de flujo de trabajo

# 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

Interactuar con elementos de trabajo

A continuación se proporcionan ejemplos básicos de cómo interactuar (mediante programación) con elementos de trabajo.

Interactuar con elementos de trabajo: 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));

Interactuar con elementos de trabajo: script ECMA

// 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));

Interactuar con elementos de trabajo: REST mediante curl

Listar elementos de trabajo de la bandeja de entrada

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

Se enumerarán los detalles de los elementos de trabajo que se encuentran actualmente en la bandeja de entrada; por ejemplo:

[{
    "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"
  }

Delegando elementos de trabajo

# 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

delegatee debe ser una opción válida para el paso del flujo de trabajo.

Completar o avanzar elementos de trabajo al paso siguiente

# 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

Escucha de eventos de flujo de trabajo

Utilice el marco de eventos OSGi para detectar los eventos que define la clase com.adobe.granite.workflow.event.WorkflowEvent. Esta clase también proporciona varios métodos útiles para obtener información sobre el asunto del evento. Por ejemplo, el método getWorkItem devuelve el objeto WorkItem para el elemento de trabajo implicado en el evento.

El siguiente código de ejemplo define un servicio que escucha eventos de flujo de trabajo y realiza tareas según el tipo de evento.

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