Interactuar con flujos de trabajo mediante programación

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

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

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:

Uso de la API de REST del flujo de trabajo

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

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

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

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

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:

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

Administración de 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}

Administración de bandejas de entrada (de usuario)

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

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

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

Ejemplos

Cómo obtener 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:

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

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

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

Ejemplo con curl:

Lista de 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

Lista de todos los modelos de flujo de trabajo: REST con curl

Ejemplo con curl:

Obtención de un objeto WorkflowSession

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

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.

Obtención de un objeto WorkflowSession: secuencia de comandos ECMA

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

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:

Los ejemplos utilizados:

Al crear un modelo nuevo:

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

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

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

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

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

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

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

Interactuar con instancias de flujo de trabajo: secuencia de comandos ECMA

Interactuar con instancias de flujo de trabajo: REST con curl

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

Interactuar con elementos de trabajo: secuencia de comandos ECMA

Interactuar con elementos de trabajo: REST con curl

Escucha de eventos de flujo de trabajo

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.