Interactuar con flujos de trabajo mediante programación interacting-with-workflows-programmatically

When personalización y ampliación de los flujos de trabajo puede acceder a los objetos de flujo de trabajo:

Uso de la API Java del flujo de trabajo using-the-workflow-java-api

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

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 deben utilizar al interactuar mediante programación con flujos de trabajo. Los siguientes ejemplos muestran cómo obtener y utilizar los objetos de clase en el código.

Obtención de objetos de flujo de trabajo en scripts ECMA obtaining-workflow-objects-in-ecma-scripts

Tal como se describe en Localización de la secuencia de comandos, AEM (a través de Apache Sling) proporciona un motor de secuencias de comandos ECMA que ejecuta secuencias de comandos ECMA del lado del servidor. La variable org.apache.sling.scripting.core.ScriptHelper está disponible inmediatamente para las secuencias de comandos, ya que la sling variable.

La variable ScriptHelper proporciona acceso a la SlingHttpServletRequest que puede usar para obtener finalmente la variable WorkflowSession objeto; por ejemplo:

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

Uso de la API de REST del flujo de trabajo using-the-workflow-rest-api

La consola Flujo de trabajo utiliza en gran medida la API de REST; por lo tanto, esta página describe la API de REST para flujos de trabajo.

Las siguientes acciones son compatibles con la API de REST:

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

La renderización admitida para GET es la renderización JSON. Las direcciones URL de GET debe tener la variable .json , por ejemplo:

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

Administración de instancias de flujo de trabajo managing-workflow-instances

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

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

Administración de una instancia de flujo de trabajo por su estado managing-a-workflow-instance-by-its-state

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

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

Administración de una instancia de flujo de trabajo por su ID managing-a-workflow-instance-by-its-id

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

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

Administración de modelos de flujo de trabajo managing-workflow-models

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

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

Ejemplo: en el explorador, una solicitud para 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 managing-a-specific-workflow-model

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

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

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

Ejemplo: en el explorador, una solicitud para http://localhost:4502/var/workflow/models/publish_example.json devuelve un valor json respuesta 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":
    {
    }
  }
]}

Administración de un modelo de flujo de trabajo por su versión managing-a-workflow-model-by-its-version

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

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

Administración de bandejas de entrada (de usuario) managing-user-inboxes

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

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

Administración de una bandeja de entrada (de usuario) mediante el ID de WorkItem managing-a-user-inbox-by-the-workitem-id

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

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

Ejemplos examples

Cómo obtener una lista de todos los flujos de trabajo en ejecución con sus ID how-to-get-a-list-of-all-running-workflows-with-their-ids

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 how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Ejemplo con curl:

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

La variable uri mostrado en los resultados se puede utilizar como instancia id en otros comandos; por ejemplo:

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

Cómo cambiar el título del flujo de trabajo how-to-change-the-workflow-title

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

Cambio del título del flujo de trabajo: REST con curl how-to-change-the-workflow-title-rest-using-curl

Ejemplo con 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/es/support/programs/eol-matrix.html). Find the supported versions [here](https://experienceleague.adobe.com/docs/?lang=es).
curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Lista de todos los modelos de flujo de trabajo how-to-list-all-workflow-models

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

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

Lista de todos los modelos de flujo de trabajo: REST con curl how-to-list-all-workflow-models-rest-using-curl

Ejemplo con curl:

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

Obtención de un objeto WorkflowSession obtaining-a-workflowsession-object

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

Obtención de un objeto WorkflowSession: Java obtaining-a-workflowsession-object-java

En una secuencia de comandos JSP (o código Java para una clase servlet), utilice el objeto de solicitud HTTP para obtener un SlingHttpServletRequest que proporciona acceso a un ResourceResolver objeto. Adaptar el ResourceResolver objeto 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: secuencia de comandos ECMA obtaining-a-workflowsession-object-ecma-script

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

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 creating-reading-or-deleting-workflow-models

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

Los ejemplos utilizados:

Al crear un modelo nuevo:

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

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

Eliminación de un modelo de flujo de trabajo: REST con 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/es/support/programs/eol-matrix.html). Find the supported versions [here](https://experienceleague.adobe.com/docs/?lang=es).
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}

Filtrado de los flujos de trabajo del sistema al comprobar el estado del flujo de trabajo filtering-out-system-workflows-when-checking-workflow-status

Puede usar la variable 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.

You puede actualizar la configuración de OSGi Carga útil de flujo de trabajo de Granite de AdobeMapCache que especifica el flujo de trabajo Models para considerarse como flujos de trabajo del sistema. Los modelos de flujo de trabajo predeterminados (en tiempo de ejecución) son:

Avance automático del paso del participante después de un tiempo de espera auto-advance-participant-step-after-a-timeout

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

Interactuar con instancias de flujo de trabajo interacting-with-workflow-instances

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

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

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

Interactuar con instancias de flujo de trabajo: REST con curl interacting-with-workflow-instances-rest-using-curl

Interactuar con elementos de trabajo interacting-with-work-items

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

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

Interactuar con elementos de trabajo: REST con curl interacting-with-work-items-rest-using-curl

Escucha de eventos de flujo de trabajo listening-for-workflow-events

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

El siguiente código de ejemplo define un servicio que escucha los 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;
 }
}