Programmgesteuerte Interaktion mit Workflows interacting-with-workflows-programmatically

Während Sie Ihre Workflows anpassen und erweitern, können Sie auf Workflow-Objekte zugreifen:

Verwendung der Workflow-Java-API using-the-workflow-java-api

Die Workflow-Java-API besteht aus dem Paket com.adobe.granite.workflow und mehreren Unterpaketen. Der wichtigste Bestandteil der API ist die com.adobe.granite.workflow.WorkflowSession-Klasse. Die WorkflowSession-Klasse ermöglicht Zugriff auf Workflow-Objekte während des Designs und während der Laufzeit:

Die Klasse bietet außerdem mehrere Methoden zum Eingreifen in Lebenszyklen von Workflows.

Die folgende Tabelle enthält Links zur Referenzdokumentation verschiedener wichtiger Java-Objekte, die bei der programmgesteuerten Interaktion mit Workflows verwendet werden. Die folgenden Beispiele zeigen, wie Sie die Klassenobjekte im Code abrufen und verwenden.

Abrufen von Workflow-Objekten in ECMA-Skripten obtaining-workflow-objects-in-ecma-scripts

Wie unter Auffinden des Skripts beschrieben, stellt AEM (über Apache Sling) eine ECMA-Skript-Engine zur Verfügung, die Server-seitige ECMA-Skripte ausführt. Die org.apache.sling.scripting.core.ScriptHelper-Klasse ist für Ihre Skripte sofort als sling-Variable verfügbar.

Die ScriptHelper-Klasse bietet Zugriff auf SlingHttpServletRequest, das Sie später verwenden können, um das Objekt WorkflowSession abzurufen. Beispiel:

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

Verwenden der Workflow-REST-API using-the-workflow-rest-api

Die Workflow-Konsole macht starken Gebrauch von der REST-API. Deshalb wird auf dieser Seite die REST-API für Workflows beschrieben.

Die folgenden Aktionen werden von der REST-API unterstützt:

Auf dieser Seite wird angenommen, dass AEM auf localhost auf Port 4502 läuft und der Installationskontext „/“ (Root-Verzeichnis) ist. Wenn dies nicht auf Ihre Installation zutrifft, müssen die URIs für die HTTP-Anfragen entsprechend angepasst werden.

Als Rendering-Methode wird für GET-Anfragen JSON-Rendering unterstützt. URLs für GET sollten die Erweiterung .json aufweisen. Beispiel:

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

Verwalten von Workflow-Instanzen managing-workflow-instances

Die folgenden HTTP-Anfragemethoden gelten für:

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

Verwalten einer Workflow-Instanz anhand ihres Status managing-a-workflow-instance-by-its-state

Die folgenden HTTP-Anfragemethoden gelten für:

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

Verwalten einer Workflow-Instanz anhand ihrer ID managing-a-workflow-instance-by-its-id

Die folgenden HTTP-Anfragemethoden gelten für:

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

Verwaltung von Workflow-Modellen managing-workflow-models

Die folgenden HTTP-Anfragemethoden gelten für:

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

Beispiel: Im Browser generiert eine Anfrage an http://localhost:4502/etc/workflow/models.json eine JSON-Antwort, die etwa wie folgt aussieht:

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

Verwalten eines bestimmten Workflow-Modells managing-a-specific-workflow-model

Die folgenden HTTP-Anfragemethoden gelten für:

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

Wo *{uri}* der Pfad zum Modellknoten im Repository ist.

Beispiel: Im Browser gibt eine Anfrage an http://localhost:4502/var/workflow/models/publish_example.json eine json-Antwort zurück, die dem folgenden Code ähnelt:

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

Verwaltung eines Workflow-Modells nach Version managing-a-workflow-model-by-its-version

Die folgenden HTTP-Anfragemethoden gelten für:

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

Verwaltung von (Benutzer-)Posteingängen managing-user-inboxes

Die folgenden HTTP-Anfragemethoden gelten für:

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

Verwalten eines (Benutzer-)Posteingangs nach WorkItem-ID managing-a-user-inbox-by-the-workitem-id

Die folgenden HTTP-Anfragemethoden gelten für:

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

Beispiele examples

Abrufen einer Liste aller laufenden Workflows mit IDs how-to-get-a-list-of-all-running-workflows-with-their-ids

Um eine Liste aller laufenden Workflows zu erhalten, führen Sie eine GET-Anfrage an folgende Adresse durch:

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

Abrufen einer Liste aller laufenden Workflows mit IDs – REST mit curl how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

Beispiel mit curl:

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

Der in den Ergebnissen angezeigte uri kann in anderen Befehlen als id der Instanz verwendet werden. Beispiel:

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

Ändern des Workflow-Titels how-to-change-the-workflow-title

Um den Workflow-Titel zu ändern, der auf der Registerkarte Instanzen der Workflow-Konsole angezeigt wird, senden Sie einen POST-Befehl:

Ändern des Workflow-Titels – REST mit curl how-to-change-the-workflow-title-rest-using-curl

Beispiel mit 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

Auflisten aller Workflow-Modelle how-to-list-all-workflow-models

Um eine Liste aller verfügbaren Workflow-Modelle zu erhalten, führen Sie eine GET-Anfrage an folgende Adresse durch:

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

Auflisten aller Workflow-Modelle – REST mit curl how-to-list-all-workflow-models-rest-using-curl

Beispiel mit curl:

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

Abrufen eines WorkflowSession-Objekts obtaining-a-workflowsession-object

Die Klasse com.adobe.granite.workflow.WorkflowSession kann aus einem javax.jcr.Session-Objekt oder einem org.apache.sling.api.resource.ResourceResolver-Objekt angepasst werden.

Abrufen eines WorkflowSession-Objekts – Java obtaining-a-workflowsession-object-java

Verwenden Sie in einem JSP-Skript (oder Java-Code für eine Servlet-Klasse) das HTTP-Anfrageobjekt, um ein SlingHttpServletRequest-Objekt abzurufen. Dieses Objekt gewährt Ihnen Zugriff auf ein ResourceResolver-Objekt. Passen Sie das ResourceResolver-Objekt für die WorkflowSession an.

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

Abrufen eines WorkflowSession Objekts – ECMA-Skript obtaining-a-workflowsession-object-ecma-script

Verwenden Sie die Variable sling, um das SlingHttpServletRequest-Objekt abzurufen, mit dem Sie ein ResourceResolver-Objekt abrufen können. Passen Sie das ResourceResolver-Objekt an das WorkflowSession-Objekt an.

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

Erstellen, Lesen oder Löschen von Workflow-Modellen creating-reading-or-deleting-workflow-models

Die folgenden Beispiele zeigen, wie Sie auf Workflow-Modelle zugreifen können:

Verwendete Beispiele:

Wenn ein Modell erstellt wird:

Erstellen, Lesen oder Löschen von Workflow-Modellen – 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);
%>

Erstellen, Lesen oder Löschen von Workflow-Modellen – 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);

Löschen eines Workflow-Modells – REST mit 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}

Herausfiltern von System-Workflows beim Prüfen des Workflow-Status filtering-out-system-workflows-when-checking-workflow-status

Mit der WorkflowStatus-API können Sie Informationen zum Workflow-Status eines Knotens abrufen.

Verschiedene Methoden haben den Parameter:

excludeSystemWorkflows

Sie können diesen Parameter auf true setzen, damit System-Workflows aus den Suchergebnissen ausgeschlossen werden.

Sie können die OSGi-Konfiguration  Adobe Granite Workflow PayloadMapCache, die die Workflow-ModelsModelle angibt, so aktualisieren, dass diese als System-Workflows betrachtet werden. Es gibt standardmäßig folgende (Laufzeit-) Workflow-Modelle:

Automatisches Fortführen eines Teilnehmerschritts nach Zeitüberschreitung auto-advance-participant-step-after-a-timeout

Wenn Sie einen Teilnehmerschritt fortführen müssen, der innerhalb eines festgelegten Zeitraums nicht abgeschlossen wurde, stehen Ihnen folgende Möglichkeiten zur Verfügung:

Interagieren mit Workflow-Instanzen interacting-with-workflow-instances

Im Folgenden finden Sie einige grundlegende Beispiele, wie Sie (programmgesteuert) mit Workflow-Instanzen interagieren.

Interagieren mit Workflow-Instanzen – 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);

Interagieren mit Workflow-Instanzen – ECMA-Skript 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);

Interagieren mit Workflow-Instanzen – REST mit curl interacting-with-workflow-instances-rest-using-curl

Interagieren mit Arbeitselementen interacting-with-work-items

Es folgen einige grundlegende Beispiele, wie Sie (programmgesteuert) mit Arbeitselementen interagieren.

Interagieren mit Arbeitselementen – 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));

Interagieren mit Arbeitselementen – ECMA-Skript 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));

Interagieren mit Arbeitselementen – REST mit curl interacting-with-work-items-rest-using-curl

Warten auf Workflow-Ereignisse listening-for-workflow-events

Verwenden Sie das OSGi-Ereignis-Framework, um auf Ereignisse zu warten, die die Klasse com.adobe.granite.workflow.event.WorkflowEvent definiert. Diese Klasse bietet auch einige nützliche Methoden zum Abrufen von Informationen über das Thema des Ereignisses. Beispielsweise gibt die Methode getWorkItem das WorkItem-Objekt für das Arbeitselement, das am Ereignis beteiligt ist, zurück.

Der folgende Beispiel-Code definiert einen Dienst, der auf Workflow-Ereignisse wartet und je nach Art des Ereignisses Aufgaben ausführt.

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