Programmgesteuerte Interaktion mit Workflows

Letzte Aktualisierung: 18. April 2024

Gilt für:
Experience Manager 6.5

Themen:
Entwicklung

Erstellt für:

Entwickler

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

Verwendung der Workflow-Java-API
Abrufen von Workflow-Objekten in ECMA-Skripten
Verwenden der Workflow-REST-API

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

Workflow-Modelle
Arbeitselemente
Workflow-Instanzen
Workflow-Daten
Posteingangselemente

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.

Funktionen

Objekte

Zugriff auf einen Workflow

WorkflowSession

Ausführung und Abfrage einer Workflow-Instanz

Workflow
WorkItem
WorkflowData

Verwaltung eines Workflow-Modells

WorkflowModel
WorkflowNode
WorkflowTransition

Informationen zu einem Knoten, der im Workflow enthalten oder nicht enthalten ist

WorkflowStatus

Abrufen von Workflow-Objekten in ECMA-Skripten

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

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

NOTE

Mit dem Kommandozeilen-Tool „curl“ können Sie durch die Workflow-REST-API auf Workflow-Objekte zugreifen und Instanzlebenszyklen verwalten. Die Beispiele auf dieser Seite zeigen die Verwendung der REST-API über das Kommandozeilen-Tool „curl“.

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

Starten oder Anhalten eines Workflow-Dienstes
Erstellen, Aktualisieren oder Löschen von Workflow-Modellen
Starten, Pausieren, Fortsetzen oder Beenden von Workflow-Instanzen
Abschließen oder Delegieren von Arbeitselementen

NOTE

Mit Firebug, einer Firefox-Erweiterung für die Web-Entwicklung, können Sie den HTTP-Traffic verfolgen, während die Konsole in Betrieb ist. Sie können beispielsweise mit einer POST-Anfrage die Parameter und Werte prüfen, die an den AEM-Server gesendet werden.

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

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Listet die verfügbaren Workflow-Instanzen auf.

POST

Erstellt eine neue Workflow-Instanz. Es gibt folgende Parameter:
– model: die ID (URI) des entsprechenden Workflow-Modells
– payloadType: enthält den Payload-Typ (z. B. JCR_PATH oder URL).
Die Payload wird als Parameterpayload gesendet. Eine 201 (CREATED)-Antwort wird mit Orts-Header zurückgesendet, der die URL der neuen Workflow-Instanzressource enthält.

Verwalten einer Workflow-Instanz anhand ihres Status

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Listet die verfügbaren Workflow-Instanzen und deren Status auf ( RUNNING, SUSPENDED, ABORTED oder COMPLETED)

Verwalten einer Workflow-Instanz anhand ihrer ID

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Ruft die Instanzdaten (Definition und Metadaten) ab, einschließlich der Verknüpfung zum entsprechenden Workflow-Modell.

POST

Ändert den Status der Instanz. Der neue Status wird als Parameter state gesendet und muss einen der folgenden Werte aufweisen: RUNNING, SUSPENDED oder ABORTED.
Wenn der neue Status nicht erreicht werden kann (z. B. wenn versucht wird, eine beendete Instanz zu pausieren), wird eine Antwort 409 (CONFLICT) an den Client zurückgesendet.

Verwaltung von Workflow-Modellen

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Listet die verfügbaren Workflow-Modelle auf.

POST

Erstellt ein neues Workflow-Modell. Wenn der Parameter title gesendet wird, wird ein neues Modell mit dem angegebenen Titel erstellt. Wenn eine JSON-Modelldefinition als Parameter model angehängt wird, wird ein neues Workflow-Modell entsprechend der angegebenen Definition erstellt.
Eine 201-Antwort (CREATED) wird mit einem Orts-Header zurückgesendet, der die URL der neuen Workflow-Modellressource enthält.
Dies geschieht auch, wenn eine Modelldefinition als Dateiparameter mit dem Namen modelfile angehängt wird.
In den beiden Fällen der Parameter model und modelfile ist ein zusätzlicher Parameter namens type erforderlich, um das Serialisierungsformat zu definieren. Neue Serialisierungsformate können mithilfe der OSGi-API integriert werden. Mit der Workflow-Engine wird ein standardmäßiges JSON-Serialisierungsprogramm bereitgestellt. Es weist den Typ „JSON“ auf. Unten sehen Sie ein Beispiel für das Format.

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

Die folgenden HTTP-Anfragemethoden gelten für:

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

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

HTTP-Anfragemethode

Aktionen

GET

Ruft die HEAD-Version des Modells (Definition und Metadaten) ab.

PUT

Aktualisiert die HEAD-Version des Modells (erstellt eine neue Version).
Die vollständige Modelldefinition für die neue Modellversion muss als Parameter namens model hinzugefügt werden. Außerdem wird ein type-Parameter wie bei der Erstellung neuer Modelle benötigt, der den Wert JSON aufweisen muss.

POST

Das gleiche Verhalten wie bei PUT. Wird benötigt, da AEM-Widgets PUT-Operationen nicht unterstützen.

DELETE

Löscht das Modell. Um Firewall-/Proxy-Probleme zu lösen, wird ein POST-Vorgang, der einen X-HTTP-Method-Override-Header-Eintrag mit dem Wert DELETE enthält, auch als DELETE-Anfrage akzeptiert.

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

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Ruft die Daten des Modells in der angegebenen Version ab (sofern vorhanden).

Verwaltung von (Benutzer-)Posteingängen

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Führt die Arbeitselemente im Posteingang des Benutzers auf, der durch die HTTP-Authentifizierungskopfzeilen identifiziert wird.

POST

Schließt das Arbeitselement ab, dessen URI als Parameter item gesendet wird, und leitet die entsprechende Workflow-Instanz an die nächsten Knoten weiter, die bei einem Rückschritt durch den Parameter route oder backroute definiert werden.
Wenn der Parameter delegatee gesendet wird, wird das vom Parameter item benannte Element an den angegebenen Teilnehmer delegiert.

Verwalten eines (Benutzer-)Posteingangs nach WorkItem-ID

Die folgenden HTTP-Anfragemethoden gelten für:

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

HTTP-Anfragemethode

Aktionen

GET

Ruft die Daten (Definition und Metadaten) des Posteingangs-WorkItem ab, das durch seine Kennung identifiziert ist.

Beispiele

Abrufen einer Liste aller laufenden Workflows mit 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

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

NOTE

Dieser curl-Befehl kann mit einem beliebigen Workflow-Status anstelle von RUNNING verwendet werden.

Ändern des Workflow-Titels

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

in: http://localhost:4502/etc/workflow/instances/{id}
mit den folgenden Parametern:
- action: Wert muss lauten: UPDATE
- workflowTitle: Titel des Workflows

Ändern des Workflow-Titels – REST mit 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

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

Beispiel mit curl:

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

NOTE

Siehe auch Verwaltung von Workflow-Modellen.

Abrufen eines WorkflowSession-Objekts

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

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

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

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

Der Code für die Java- und ECMA-Skripte verwendet die Methode WorkflowSession.createNewModel.
Der curl-Befehl greift anhand der URL direkt auf das Modell zu.

Verwendete Beispiele:

Erstellen Sie ein Modell (mit der ID /var/workflow/models/mymodel/jcr:content/model).
Löschen Sie das Modell.

NOTE

Wenn Sie das Modell löschen, wird die Eigenschaft deleted des untergeordneten metaData-Knotens auf true gesetzt.

Durch das Löschen wird der Modellknoten nicht entfernt.

Wenn ein Modell erstellt wird:

Der Workflow-Modell-Editor erfordert, dass Modelle eine bestimmte Knotenstruktur unter /var/workflow/models verwenden. Der übergeordnete Knoten des Modells muss den Typ cq:Page und einen jcr:content-Knoten mit den folgenden Eigenschaftswerten aufweisen:
- sling:resourceType: cq/workflow/components/pages/model
- cq:template: /libs/cq/workflow/templates/model
Wenn Sie ein Modell erstellen, müssen Sie zunächst diesen cq:Page-Knoten erstellen und seinen jcr:content-Knoten als übergeordneten Knoten des Modellknotens verwenden.
Das id-Argument, das einige Methoden zum Benennen des Modells erfordern, ist der absolute Pfad des Modellknotens im Repository:

/var/workflow/models/<*model_name>*/jcr:content/model

NOTE
Siehe Auflisten aller Workflow-Modelle.

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

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 the model by its id
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}

NOTE

Aufgrund der erforderlichen Detailtiefe gilt curl nicht als praktikabel für das Erstellen und/oder Lesen eines Modells.

Herausfiltern von System-Workflows beim Prüfen des 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:

/var/workflow/models/scheduled_activation/jcr:content/model
/var/workflow/models/scheduled_deactivation/jcr:content/model

Automatisches Fortführen eines Teilnehmerschritts nach Zeitüberschreitung

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

Implementieren Sie einen OSGI-Ereignis-Listener für die Erstellung und Bearbeitung von Aufgaben.
Geben Sie ein Zeit-Limit (eine Deadline) an und erstellen Sie anschließend einen geplanten Sling-Auftrag, der zu diesem Zeitpunkt ausgelöst wird.
Erstellen Sie einen Auftrags-Handler, der benachrichtigt wird, wenn das Zeitlimit abgelaufen ist, und den Auftrag auslöst.

Dieser Handler führt die erforderlichen Handlungen zum Auftrag durch, wenn dieser noch nicht abgeschlossen ist.

NOTE

Die durchzuführende Aktion muss eindeutig definiert sein, damit diese Vorgehensweise verwendet werden kann.

Interagieren mit Workflow-Instanzen

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

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

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

Starten eines Workflows

# starting a workflow
curl -d "model={id}&payloadType={type}&payload={payload}" http://localhost:4502/etc/workflow/instances

# for example:
curl -u admin:admin -d "model=/var/workflow/models/request_for_activation&payloadType=JCR_PATH&payload=/content/we-retail/us/en/products" http://localhost:4502/etc/workflow/instances

Auflisten der Instanzen

# listing the instances
curl -u admin:admin http://localhost:4502/etc/workflow/instances.json

Hierdurch werden alle Instanzen aufgelistet, z. B.:

[
    {"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_1"}
    ,{"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_2"}
]

NOTE

Sehen Sie sich Abrufen einer Liste aller laufenden Workflows mit ihren IDs an, um zu erfahren, wie Sie Instanzen mit einem bestimmten Status auflisten.

Pausieren eines Workflows

# suspending a workflow
curl -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Fortsetzen eines Workflows

# resuming a workflow
curl -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Beenden einer Workflow-Instanz

# terminating a workflow
curl -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

Interagieren mit Arbeitselementen

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

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

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

Auflisten von Arbeitselementen aus dem Posteingang

# listing the work items
curl -u admin:admin http://localhost:4502/bin/workflow/inbox

Es werden Details zu Arbeitselementen aufgelistet, die sich derzeit im Posteingang befinden. Beispiel:

[{
    "uri_xss": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
    "uri": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
    "currentAssignee_xss": "workflow-administrators",
    "currentAssignee": "workflow-administrators",
    "startTime": 1519656289274,
    "payloadType_xss": "JCR_PATH",
    "payloadType": "JCR_PATH",
    "payload_xss": "/content/we-retail/es/es",
    "payload": "/content/we-retail/es/es",
    "comment_xss": "Process resource is null",
    "comment": "Process resource is null",
    "type_xss": "WorkItem",
    "type": "WorkItem"
  },{
    "uri_xss": "configuration/configure_analyticstargeting",
    "uri": "configuration/configure_analyticstargeting",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/securitychecklist",
    "uri": "configuration/securitychecklist",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/enable_collectionofanonymoususagedata",
    "uri": "configuration/enable_collectionofanonymoususagedata",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/configuressl",
    "uri": "configuration/configuressl",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  }

Delegieren von Arbeitselementen

# delegating
curl -d "item={item}&delegatee={delegatee}" http://localhost:4502/bin/workflow/inbox

# for example:
curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_act_1&delegatee=administrators" http://localhost:4502/bin/workflow/inbox

NOTE

Der delegatee muss eine gültige Option für den Workflow-Schritt sein.

Abschließen oder Fortführen von Arbeitselementen zum nächsten Schritt

# retrieve the list of routes; the results will be similar to {"results":1,"routes":[{"rid":"233123169","label":"End","label_xss":"End"}]}
http://localhost:4502/etc/workflow/instances/<path-to-the-workitem>.routes.json

# completing or advancing to the next step; use the appropriate route ID (rid value) from the above list
curl -d "item={item}&route={route}" http://localhost:4502/bin/workflow/inbox

# for example:
curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_activation_1&route=233123169" http://localhost:4502/bin/workflow/inbox

Warten auf Workflow-Ereignisse

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

recommendation-more-help