Programmatische interactie met Workflows interacting-with-workflows-programmatically

Wanneer uw workflows aanpassen en uitbreiden u hebt toegang tot workflowobjecten:

De Java API voor de workflow gebruiken using-the-workflow-java-api

De workflow Java API bestaat uit de com.adobe.granite.workflow verpakking en verscheidene subpakketten. Het belangrijkste lid van de API is de com.adobe.granite.workflow.WorkflowSession klasse. De WorkflowSession klasse biedt toegang tot workflowobjecten tijdens het ontwerpen en bij uitvoering:

De klasse biedt ook verschillende methoden voor het ingrijpen in workflowlevenscycli.

De volgende tabel bevat koppelingen naar de referentiedocumentatie van verschillende belangrijke Java-objecten die moeten worden gebruikt wanneer programmatisch wordt gewerkt met workflows. De volgende voorbeelden demonstreren hoe u de klassenobjecten in code verkrijgt en gebruikt.

Workflowobjecten verkrijgen in ECMA-scripts obtaining-workflow-objects-in-ecma-scripts

Zoals beschreven in Script zoeken, AEM (via Apache Sling) biedt een ECMA-scriptengine die ECMA-scripts op de server uitvoert. De org.apache.sling.scripting.core.ScriptHelper -klasse is direct beschikbaar voor uw scripts als de sling variabele.

De ScriptHelper klasse verleent toegang tot SlingHttpServletRequest die u kunt gebruiken om uiteindelijk de WorkflowSession object; bijvoorbeeld:

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

De REST-API voor workflows gebruiken using-the-workflow-rest-api

De workflowconsole maakt intensief gebruik van de REST API, zodat deze pagina de REST API voor workflows beschrijft.

De volgende acties worden ondersteund met de REST API:

Op deze pagina wordt aangenomen dat AEM op localhost op poort wordt uitgevoerd 4502 en dat de installatiecontext " /" (basis). Als dit niet het geval is voor uw installatie, moeten de URI's, waarop de HTTP-aanvragen van toepassing zijn, dienovereenkomstig worden aangepast.

De ondersteunde rendering voor GET Aanvragen zijn de JSON-rendering. De URL's voor GET moet de .json bijvoorbeeld:

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

Workflowinstanties beheren managing-workflow-instances

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Een Werkstroominstantie beheren door de betreffende staat managing-a-workflow-instance-by-its-state

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Een Werkstroominstantie beheren met de id managing-a-workflow-instance-by-its-id

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Workflowmodellen beheren managing-workflow-models

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Voorbeeld: in de browser kunt u een aanvraag indienen op http://localhost:4502/etc/workflow/models.json Hiermee genereert u een JSON-reactie die vergelijkbaar is met het volgende:

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

Een specifiek workflowmodel beheren managing-a-specific-workflow-model

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Wanneer *{uri}* Dit is het pad naar het modelknooppunt in de repository.

Voorbeeld: in de browser kunt u een aanvraag indienen op http://localhost:4502/var/workflow/models/publish_example.json retourneert een json reactie die vergelijkbaar is met de volgende code:

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

Een workflowmodel beheren op basis van de versie managing-a-workflow-model-by-its-version

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Invakken (gebruikers) beheren managing-user-inboxes

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Het beheren van een (Gebruiker) Inbox door identiteitskaart WorkItem managing-a-user-inbox-by-the-workitem-id

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

Voorbeelden examples

Hoe te om een Lijst van alle Lopende Werkschema's met hun IDs te krijgen how-to-get-a-list-of-all-running-workflows-with-their-ids

Voer een GET uit om een lijst met alle actieve workflows op te halen:

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

Hoe te om een Lijst van alle Lopende Werkschema's met hun identiteitskaart te krijgen - REST gebruikend krullen how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Voorbeeld met krullen:

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

De uri weergegeven in de resultaten kunnen worden gebruikt als de instantie id in andere opdrachten, bijvoorbeeld:

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

Hoe te om de Titel van het Werkschema te veranderen how-to-change-the-workflow-title

Als u het dialoogvenster Werkstroomtitel weergegeven in het dialoogvenster Instanties tabblad van de workflowconsole, een POST opdracht:

Hoe te om de Titel van het Werkschema te veranderen - REST gebruikend krullen how-to-change-the-workflow-title-rest-using-curl

Voorbeeld met krullen:

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

Hoe te om van alle Modellen van het Werkschema een lijst te maken how-to-list-all-workflow-models

Ga als volgt te werk om een lijst met alle beschikbare workflowmodellen op te halen:

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

Hoe te om van alle Modellen van het Werkschema een lijst te maken - REST gebruikend curl how-to-list-all-workflow-models-rest-using-curl

Voorbeeld met krullen:

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

Een WorkflowSession-object verkrijgen obtaining-a-workflowsession-object

De com.adobe.granite.workflow.WorkflowSession klasse kan worden aangepast vanuit een javax.jcr.Session object of een org.apache.sling.api.resource.ResourceResolver object.

Een WorkflowSession-object verkrijgen - Java obtaining-a-workflowsession-object-java

Gebruik in een JSP-script (of Java-code voor een servlet-klasse) het HTTP-aanvraagobject om een SlingHttpServletRequest object, dat toegang biedt tot een ResourceResolver object. Pas het ResourceResolver object naar 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);
%>

Een WorkflowSession-object verkrijgen - ECMA-script obtaining-a-workflowsession-object-ecma-script

Gebruik de sling variabele om de SlingHttpServletRequest object dat u gebruikt om een ResourceResolver object. Pas het ResourceResolver aan WorkflowSession object.

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

Workflowmodellen maken, lezen of verwijderen creating-reading-or-deleting-workflow-models

In de volgende voorbeelden ziet u hoe u workflowmodellen kunt openen:

De gebruikte voorbeelden:

Bij het maken van een model:

Workflowmodellen maken, lezen of verwijderen - 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);
%>

Workflowmodellen maken, lezen of verwijderen - ECMA-script 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);

Een workflowmodel verwijderen - HERSTELLEN met 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}

Systeemworkflows filteren bij het controleren van workflowstatus filtering-out-system-workflows-when-checking-workflow-status

U kunt de WorkflowStatus-API om informatie over de werkschemastatus van een knoop terug te winnen.

Verschillende methoden hebben de parameter:

excludeSystemWorkflows

Deze parameter kan worden ingesteld op true om aan te geven dat systeemworkflows van de relevante resultaten moeten worden uitgesloten.

U kan de configuratie bijwerken OSGi Adobe Granite Workflow PayloadMapCache die de workflow aangeeft Models als systeemworkflows worden beschouwd. De standaardworkflowmodellen (runtime) zijn:

Stap van de Deelnemer van de auto-Geavanceerde na een Onderbreking auto-advance-participant-step-after-a-timeout

Als u automatisch een Deelnemer stap die niet binnen een vooraf bepaalde tijd is voltooid u kunt:

Interactie met workflowinstanties interacting-with-workflow-instances

Hieronder vindt u basisvoorbeelden van de wijze waarop u programmatisch kunt communiceren met workflowinstanties.

Interactie met workflowinstanties - 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);

Interactie met workflowinstanties - 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);

Interactie met Workflowinstanties - REST gebruiken met curl interacting-with-workflow-instances-rest-using-curl

Interactie met werkitems interacting-with-work-items

Het volgende verstrekt basisvoorbeelden van hoe te (programmatisch) met het werkpunten in wisselwerking te staan.

Interactie met werkitems - 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));

Interactie met werkitems - 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));

Interactie met werkitems - HERSTEL met krullen interacting-with-work-items-rest-using-curl

Luisteren naar workflowgebeurtenissen listening-for-workflow-events

Gebruik het OSGi-gebeurtenisframework om te luisteren naar gebeurtenissen die com.adobe.granite.workflow.event.WorkflowEvent definieert. Deze klasse biedt ook verschillende nuttige methoden om informatie over het onderwerp van de gebeurtenis te verkrijgen. Bijvoorbeeld de getWorkItem methode retourneert de methode WorkItem object voor het werkitem dat bij de gebeurtenis is betrokken.

De volgende voorbeeldcode definieert een service die luistert naar workflowgebeurtenissen en taken uitvoert op basis van het type gebeurtenis.

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