Interagera med arbetsflöden programmatiskt interacting-with-workflows-programmatically

När du anpassar och utökar dina arbetsflöden får du tillgång till arbetsflödesobjekt:

Använda Java API för arbetsflöde using-the-workflow-java-api

Arbetsflödets Java API består av paketet com.adobe.granite.workflow och flera underpaket. Den viktigaste medlemmen i API är klassen com.adobe.granite.workflow.WorkflowSession. Klassen WorkflowSession ger åtkomst till arbetsflödesobjekt för både designtid och körning:

Klassen innehåller också flera metoder för att hantera arbetsflödets livscykler.

Följande tabell innehåller länkar till referensdokumentationen för flera viktiga Java-objekt som kan användas när du interagerar programmatiskt med arbetsflöden. Exemplen som följer visar hur du hämtar och använder klassobjekten i koden.

Hämta arbetsflödesobjekt i ECMA-skript obtaining-workflow-objects-in-ecma-scripts

Så som beskrivs i Hitta skriptet, AEM (via Apache Sling) tillhandahåller en ECMA-skriptmotor som kör ECMA-skript på serversidan. Klassen org.apache.sling.scripting.core.ScriptHelper är omedelbart tillgänglig för dina skript som variabeln sling.

Klassen ScriptHelper ger åtkomst till SlingHttpServletRequest som du kan använda för att till slut få fram objektet WorkflowSession, till exempel:

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

Använda REST API för arbetsflöde using-the-workflow-rest-api

Arbetsflödeskonsolen använder REST API i stor utsträckning, så den här sidan beskriver REST API för arbetsflöden.

Följande åtgärder stöds med REST API:

På den här sidan antas att AEM körs på localhost på port 4502 och att installationskontexten är / (rot). Om det inte är fallet med din installation måste de URI:er som HTTP-begäran gäller anpassas därefter.

Den återgivning som stöds för GET-begäranden är JSON-återgivningen. URL:erna för GET ska ha tillägget .json, till exempel:

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

Hantera arbetsflödesinstanser managing-workflow-instances

Följande metoder för HTTP-begäran gäller:

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

Hantera en arbetsflödesinstans utifrån dess tillstånd managing-a-workflow-instance-by-its-state

Följande metoder för HTTP-begäran gäller:

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

Hantera en arbetsflödesinstans med dess ID managing-a-workflow-instance-by-its-id

Följande metoder för HTTP-begäran gäller:

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

Hantera arbetsflödesmodeller managing-workflow-models

Följande metoder för HTTP-begäran gäller:

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

Exempel: i webbläsaren genererar en begäran till http://localhost:4502/etc/workflow/models.json ett json-svar som liknar följande:

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

Hantera en specifik arbetsflödesmodell managing-a-specific-workflow-model

Följande metoder för HTTP-begäran gäller:

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

Där *{uri}* är sökvägen till modellnoden i databasen.

Exempel: i webbläsaren returnerar en begäran till http://localhost:4502/var/workflow/models/publish_example.json ett json-svar som liknar följande kod:

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

Hantera en arbetsflödesmodell med dess version managing-a-workflow-model-by-its-version

Följande metoder för HTTP-begäran gäller:

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

Hantera (användare) inkorgar managing-user-inboxes

Följande metoder för HTTP-begäran gäller:

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

Hantera en (Användare) inkorg med WorkItem-ID managing-a-user-inbox-by-the-workitem-id

Följande metoder för HTTP-begäran gäller:

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

Exempel examples

Hämta en lista över alla arbetsflöden som körs med deras ID:n how-to-get-a-list-of-all-running-workflows-with-their-ids

Om du vill visa en lista över alla arbetsflöden som körs gör du en GET till:

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

Hämta en lista över alla arbetsflöden som körs med deras ID:n - REST med URL how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Exempel med vändning:

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

uri som visas i resultaten kan användas som instans id i andra kommandon, till exempel:

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

Ändra arbetsflödets titel how-to-change-the-workflow-title

Om du vill ändra arbetsflödets titel som visas på fliken Instanser i arbetsflödeskonsolen skickar du ett POST-kommando:

Ändra arbetsflödets titel - REST med vändning how-to-change-the-workflow-title-rest-using-curl

Exempel med vändning:

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

Lista alla arbetsflödesmodeller how-to-list-all-workflow-models

Om du vill visa en lista över alla tillgängliga arbetsflödesmodeller gör du en GET till:

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

Så här listar du alla arbetsflödesmodeller - REST med kurva how-to-list-all-workflow-models-rest-using-curl

Exempel med vändning:

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

Hämta ett WorkflowSession-objekt obtaining-a-workflowsession-object

Klassen com.adobe.granite.workflow.WorkflowSession kan anpassas från ett javax.jcr.Session-objekt eller ett org.apache.sling.api.resource.ResourceResolver-objekt.

Hämta ett WorkflowSession-objekt - Java obtaining-a-workflowsession-object-java

I ett JSP-skript (eller Java-kod för en serletklass) använder du objektet för HTTP-begäran för att hämta ett SlingHttpServletRequest-objekt, som ger åtkomst till ett ResourceResolver-objekt. Anpassa objektet ResourceResolver till 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);
%>

Hämta ett WorkflowSession-objekt - ECMA-skript obtaining-a-workflowsession-object-ecma-script

Använd variabeln sling för att hämta det SlingHttpServletRequest-objekt som du använder för att hämta ett ResourceResolver-objekt. Anpassa objektet ResourceResolver till objektet WorkflowSession.

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

Skapa, läsa eller ta bort arbetsflödesmodeller creating-reading-or-deleting-workflow-models

I följande exempel visas hur du får åtkomst till arbetsflödesmodeller:

De exempel som används:

När du skapar en modell:

Skapa, läsa eller ta bort arbetsflödesmodeller - 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);
%>

Skapa, läsa eller ta bort arbetsflödesmodeller - ECMA-skript 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);

Ta bort en arbetsflödesmodell - REST med vändning 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}

Filtrera ut systemarbetsflöden när arbetsflödesstatus kontrolleras filtering-out-system-workflows-when-checking-workflow-status

Du kan använda WorkflowStatus API för att hämta information om arbetsflödesstatus för en nod.

Olika metoder har parametern:

excludeSystemWorkflows

Den här parametern kan ställas in på true för att ange att systemarbetsflöden ska uteslutas från relevanta resultat.

Du kan uppdatera OSGi-konfigurationen Adobe Granite Workflow PayloadMapCache som anger att arbetsflödet Models ska betraktas som systemarbetsflöden. Standardarbetsflödesmodellerna (runtime) är:

Gå automatiskt vidare till deltagarsteget efter en timeout auto-advance-participant-step-after-a-timeout

Om du behöver gå vidare till ett Deltagare-steg automatiskt som inte har slutförts inom en fördefinierad tid kan du:

Interagera med arbetsflödesinstanser interacting-with-workflow-instances

Nedan finns grundläggande exempel på hur du interagerar (programmatiskt) med arbetsflödesinstanser.

Interagera med arbetsflödesinstanser - 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);

Interagera med arbetsflödesinstanser - ECMA Script 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);

Interagera med arbetsflödesinstanser - REST med vändning interacting-with-workflow-instances-rest-using-curl

Interagera med arbetsuppgifter interacting-with-work-items

Nedan följer grundläggande exempel på hur du interagerar (programmatiskt) med arbetsobjekt.

Interagera med arbetsuppgifter - 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));

Interagera med arbetsobjekt - ECMA Script 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));

Interagera med arbetsobjekt - REST med vändning interacting-with-work-items-rest-using-curl

Lyssna efter arbetsflödeshändelser listening-for-workflow-events

Använd OSGi-händelseramverket för att lyssna efter händelser som definieras av klassen com.adobe.granite.workflow.event.WorkflowEvent. Den här klassen innehåller också flera användbara metoder för att hämta information om föremålet för händelsen. Metoden getWorkItem returnerar till exempel objektet WorkItem för det arbetsobjekt som är involverat i händelsen.

I följande exempelkod definieras en tjänst som avlyssnar arbetsflödeshändelser och utför åtgärder utifrån händelsetypen.

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