Interação programática com fluxos de trabalho interacting-with-workflows-programmatically

Ao personalizar e estender seus fluxos de trabalho, você pode acessar objetos de fluxo de trabalho:

Uso da API Java do fluxo de trabalho using-the-workflow-java-api

A API Java do fluxo de trabalho consiste no pacote com.adobe.granite.workflow e em vários pacotes secundários. O membro mais significativo da API é a classe com.adobe.granite.workflow.WorkflowSession. A classe WorkflowSession fornece acesso aos objetos de fluxo de trabalho de tempo de design e de tempo de execução:

A classe também fornece vários métodos para intervir nos ciclos de vida do fluxo de trabalho.

A tabela a seguir fornece links para a documentação de referência de vários objetos Java principais para usar ao interagir programaticamente com workflows. Os exemplos a seguir demonstram como obter e usar os objetos de classe no código.

Obtenção de Objetos de Workflow em Scripts ECMA obtaining-workflow-objects-in-ecma-scripts

Conforme descrito em Localizando o Script, o AEM (via Apache Sling) fornece um mecanismo de script ECMA que executa scripts ECMA do lado do servidor. A classe org.apache.sling.scripting.core.ScriptHelper está imediatamente disponível para seus scripts como a variável sling.

A classe ScriptHelper fornece acesso ao SlingHttpServletRequest que você pode usar para eventualmente obter o objeto WorkflowSession; por exemplo:

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

Uso da API REST do workflow using-the-workflow-rest-api

O console Fluxo de trabalho faz grande uso da REST API; portanto, esta página descreve a REST API para fluxos de trabalho.

As seguintes ações são compatíveis com a REST API:

Nesta página, presume-se que o AEM seja executado no host local na porta 4502 e que o contexto de instalação seja " /" (raiz). Se não for o caso de sua instalação, os URIs, aos quais as solicitações HTTP se aplicam, precisam ser adaptados adequadamente.

A renderização com suporte para GET solicitações é a renderização JSON. As URLs de GET devem ter a extensão .json, por exemplo:

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

Gerenciamento de instâncias de fluxo de trabalho managing-workflow-instances

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Gerenciar uma instância de fluxo de trabalho por seu estado managing-a-workflow-instance-by-its-state

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Gerenciamento de uma instância de fluxo de trabalho por sua ID managing-a-workflow-instance-by-its-id

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Gerenciamento de modelos de fluxo de trabalho managing-workflow-models

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Exemplo: no navegador, uma solicitação para http://localhost:4502/etc/workflow/models.json gera uma resposta json semelhante à seguinte:

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

Gerenciamento de um modelo de fluxo de trabalho específico managing-a-specific-workflow-model

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Onde *{uri}* é o caminho para o nó do modelo no repositório.

Exemplo: no navegador, uma solicitação para http://localhost:4502/var/workflow/models/publish_example.json retorna uma resposta json que é semelhante ao seguinte 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":
    {
    }
  }
]}

Gerenciamento de um modelo de fluxo de trabalho por sua versão managing-a-workflow-model-by-its-version

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Gerenciar Caixas De Entrada (Usuário) managing-user-inboxes

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Gerenciar uma caixa de entrada (usuário) pelo ID do item de trabalho managing-a-user-inbox-by-the-workitem-id

Os seguintes métodos de solicitação HTTP se aplicam a:

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

Exemplos examples

Como obter uma lista de todos os fluxos de trabalho em execução com suas IDs how-to-get-a-list-of-all-running-workflows-with-their-ids

Para obter uma lista de todos os workflows em execução, faça uma GET para:

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

Como obter uma lista de todos os fluxos de trabalho em execução com suas IDs - REST usando curl how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Exemplo usando curl:

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

A uri exibida nos resultados pode ser usada como a instância id em outros comandos; por exemplo:

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

Como alterar o título do fluxo de trabalho how-to-change-the-workflow-title

Para alterar o Título do Fluxo de Trabalho exibido na guia Instâncias do console de fluxo de trabalho, envie um comando POST:

Como alterar o título do fluxo de trabalho - REST usando curl how-to-change-the-workflow-title-rest-using-curl

Exemplo usando 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

Como listar todos os modelos de fluxo de trabalho how-to-list-all-workflow-models

Para obter uma lista de todos os modelos de fluxo de trabalho disponíveis, faça uma GET para:

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

Como listar todos os modelos de fluxo de trabalho - REST usando curl how-to-list-all-workflow-models-rest-using-curl

Exemplo usando curl:

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

Obter um objeto WorkflowSession obtaining-a-workflowsession-object

A classe com.adobe.granite.workflow.WorkflowSession é adaptável de um objeto javax.jcr.Session ou de um objeto org.apache.sling.api.resource.ResourceResolver.

Obter um objeto WorkflowSession - Java obtaining-a-workflowsession-object-java

Em um script JSP (ou código Java para uma classe de servlet), use o objeto de solicitação HTTP para obter um objeto SlingHttpServletRequest, que fornece acesso a um objeto ResourceResolver. Adapte o 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);
%>

Obter um objeto WorkflowSession - Script ECMA obtaining-a-workflowsession-object-ecma-script

Use a variável sling para obter o objeto SlingHttpServletRequest usado para obter um objeto ResourceResolver. Adapte o objeto ResourceResolver ao objeto WorkflowSession.

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

Criação, leitura ou exclusão de modelos de fluxo de trabalho creating-reading-or-deleting-workflow-models

Os seguintes exemplos mostram como acessar modelos de fluxo de trabalho:

Os exemplos usados:

Ao criar um modelo:

Criação, leitura ou exclusão de modelos de fluxo de trabalho - 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);
%>

Criação, Leitura ou Exclusão de Modelos de Workflow - 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);

Excluir um modelo de fluxo de trabalho - REST usando curl deleting-a-workflow-model-rest-using-curl

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

Filtrar fluxos de trabalho do sistema ao verificar o status do fluxo de trabalho filtering-out-system-workflows-when-checking-workflow-status

Você pode usar a API WorkflowStatus para recuperar informações sobre o status do fluxo de trabalho de um nó.

Vários métodos têm o parâmetro:

excludeSystemWorkflows

Esse parâmetro pode ser definido como true para indicar que os fluxos de trabalho do sistema devem ser excluídos dos resultados relevantes.

Você pode atualizar a configuração OSGi PayloadMapCache do fluxo de trabalho do Adobe Granite que especifica o fluxo de trabalho Models a ser considerado como fluxos de trabalho do sistema. Os modelos de fluxo de trabalho padrão (tempo de execução) são:

Avançar automaticamente a etapa do participante após um tempo limite auto-advance-participant-step-after-a-timeout

Se você precisar avançar automaticamente uma etapa Participante que não foi concluída em um tempo predefinido, você pode:

Interagir com instâncias de fluxo de trabalho interacting-with-workflow-instances

Veja a seguir exemplos básicos de como interagir (de forma programática) com instâncias de fluxo de trabalho.

Interagir com instâncias de fluxo de trabalho - 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);

Interação com instâncias de fluxo de trabalho - 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);

Interagir com instâncias de fluxo de trabalho - REST usando curl interacting-with-workflow-instances-rest-using-curl

Interagir com itens de trabalho interacting-with-work-items

Veja a seguir exemplos básicos de como interagir (programaticamente) com itens de trabalho.

Interagir com itens de trabalho - 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));

Interagir com Itens de Trabalho - 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));

Interagir com itens de trabalho - REST usando curl interacting-with-work-items-rest-using-curl

Acompanhamento de eventos de fluxo de trabalho listening-for-workflow-events

Use a estrutura de eventos OSGi para acompanhar eventos definidos pela classe com.adobe.granite.workflow.event.WorkflowEvent. Esta classe também fornece vários métodos úteis para obter informações sobre o assunto do evento. Por exemplo, o método getWorkItem retorna o objeto WorkItem para o item de trabalho envolvido no evento.

O código de exemplo a seguir define um serviço que escuta eventos de fluxo de trabalho e executa tarefas de acordo com o 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;
 }
}