Programmatische interactie met Workflows

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Ontwikkelen

Gemaakt voor:

Ontwikkelaar

Wanneer het aanpassen en het uitbreiden van uw werkschema'su tot werkschemavoorwerpen kunt toegang hebben:

De Java API voor de workflow gebruiken
Workflowobjecten verkrijgen in ECMA-scripts
De REST-API voor workflows gebruiken

De Java API voor de workflow gebruiken

De workflow-Java API bestaat uit het com.adobe.granite.workflow-pakket en diverse subpakketten. Het belangrijkste lid van de API is de com.adobe.granite.workflow.WorkflowSession -klasse. De klasse WorkflowSession biedt toegang tot workflowobjecten tijdens het ontwerpen en uitvoeren:

workflowmodellen
werkartikelen
workflowinstanties
workflowgegevens
items in postvak

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.

Functies

Objecten

Een workflow openen

WorkflowSession

Een workflowinstantie uitvoeren en opvragen

Workflow
WorkItem
WorkflowData

Een workflowmodel beheren

WorkflowModel
WorkflowNode
WorkflowTransition

Informatie voor een knooppunt in de workflow (of niet)

WorkflowStatus

Workflowobjecten verkrijgen in ECMA-scripts

Zoals die in van het Manuscriptwordt beschreven, verstrekt AEM (via Apache Sling) een ECMA manuscriptmotor die server-kant manuscripten ECMA uitvoert. De org.apache.sling.scripting.core.ScriptHelperklasse is onmiddellijk beschikbaar aan uw manuscripten als sling variabele.

De klasse ScriptHelper biedt toegang tot de klasse SlingHttpServletRequest die u kunt gebruiken om uiteindelijk het object WorkflowSession te verkrijgen, bijvoorbeeld:

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

De REST-API voor workflows gebruiken

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

NOTE

Met het opdrachtregelprogramma 'curl' kunt u de REST-API voor workflowobjecten gebruiken om toegang te krijgen tot workflowobjecten en de levenscycli van instanties te beheren. De voorbeelden op deze pagina demonstreren het gebruik van de REST API via het curl opdrachtregelprogramma.

De volgende acties worden ondersteund met de REST API:

een workflowservice starten of stoppen
workflowmodellen maken, bijwerken of verwijderen
workflowinstanties starten, opschorten, hervatten of beëindigen
volledige of gedelegeerde werkitems

NOTE

Met Firebug, een Firefox-extensie voor webontwikkeling, kunt u het HTTP-verkeer volgen wanneer de console wordt uitgevoerd. U kunt bijvoorbeeld de parameters en de waarden controleren die met een POST -aanvraag naar de AEM server worden verzonden.

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

De rendering die wordt ondersteund voor GET -aanvragen is de JSON-rendering. De URL's voor GET moeten bijvoorbeeld de extensie .json hebben:

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

Workflowinstanties beheren

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Hier worden de beschikbare workflowinstanties weergegeven.

POST

Maakt een nieuwe werkstroominstantie. De parameters zijn:
- model: identiteitskaart (URI) van het respectieve werkschemamodel
- payloadType: die het type van de lading (bijvoorbeeld, JCR_PATH of URL) bevatten.
De payload wordt verzonden als parameter payload . Een 201 (CREATED) reactie wordt teruggestuurd met een plaatsheader die URL van het nieuwe middel van de werkschemainstantie bevat.

Een Werkstroominstantie beheren door de betreffende staat

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Hier worden de beschikbare workflowinstanties en hun statussen weergegeven ( RUNNING , SUSPENDED , ABORTED of COMPLETED)

Een Werkstroominstantie beheren met de id

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Haalt de gegevens van de instanties (definitie en metagegevens) op, inclusief de koppeling naar het respectievelijke workflowmodel.

POST

Wijzigt de status van de instantie. De nieuwe status wordt verzonden als de parameter state en moet een van de volgende waarden hebben: RUNNING, SUSPENDED of ABORTED .
Als de nieuwe status niet bereikbaar is (bijvoorbeeld bij het opschorten van een beëindigde instantie), wordt een 409 (CONFLICT) reactie teruggestuurd naar de client.

Workflowmodellen beheren

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Hier worden de beschikbare workflowmodellen weergegeven.

POST

Maakt een nieuw workflowmodel. Wanneer de parameter title wordt verzonden, wordt een nieuw model gemaakt met de opgegeven titel. Als u een JSON-modeldefinitie als parameter koppelt model , wordt een nieuw workflowmodel gemaakt volgens de opgegeven definitie.
Een 201 reactie (CREATED) wordt teruggestuurd met een plaatsheader die URL van het nieuwe werkschemamodel bevat.
Hetzelfde gebeurt wanneer een modeldefinitie wordt gekoppeld als een bestandsparameter met de naam modelfile .
In beide gevallen van de parameters model en modelfile is een extra parameter met de naam type vereist om de serialisatie-indeling te definiëren. De nieuwe rangschikkingsformaten kunnen worden geïntegreerd gebruikend OSGI API. Er wordt een standaard JSON-serializer geleverd met de workflow-engine. Het type is JSON. Zie hieronder voor een voorbeeld van de opmaak.

Voorbeeld: in de browser genereert een aanvraag naar http://localhost:4502/etc/workflow/models.json een reactie van de arts die lijkt op 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

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

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

HTTP-aanvraagmethode

Handelingen

GET

Hiermee wordt de HEAD -versie van het model opgehaald (definitie en metagegevens).

PUT

Werkt de HEAD -versie van het model bij (maakt een nieuwe versie).
De volledige modeldefinitie voor de nieuwe versie van het model moet worden toegevoegd als een parameter met de naam model . Bovendien is een type parameter nodig zoals wanneer het creëren van nieuwe modellen en moet de waarde hebben JSON.

POST

Hetzelfde gedrag als bij PUT. Nodig omdat AEM widgets PUT -bewerkingen niet ondersteunen.

DELETE

Hiermee verwijdert u het model. Als u firewall-/proxyproblemen wilt oplossen, wordt een POST -item met een X-HTTP-Method-Override header-item met waarde DELETE ook geaccepteerd als DELETE -aanvraag.

Voorbeeld: in de browser retourneert een aanvraag naar http://localhost:4502/var/workflow/models/publish_example.json 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

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Haalt de gegevens van het model op in de opgegeven versie (indien aanwezig).

Invakken (gebruikers) beheren

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Maakt een lijst van de het werkpunten die in inbox van de gebruiker zijn, die door de de authentificatiekopballen van HTTP wordt geïdentificeerd.

POST

Voltooit het werkitem waarvan de URI als parameter item wordt verzonden en gaat de instantie van de workflow volgens door naar de volgende knooppunten, die door de parameter route wordt gedefinieerd of backroute als er een stap terug wordt gedaan.
Als de parameter delegatee wordt verzonden, wordt het werkitem dat door de parameter item wordt geïdentificeerd, gedelegeerd aan de opgegeven deelnemer.

Het beheren van een (Gebruiker) Inbox door identiteitskaart WorkItem

De volgende HTTP-aanvraagmethoden zijn van toepassing op:

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

HTTP-aanvraagmethode

Handelingen

GET

Haalt de gegevens (definitie en metagegevens) op van het inbox WorkItem dat door de id ervan wordt geïdentificeerd.

Voorbeelden

Hoe te om een Lijst van alle Lopende Werkschema's met hun IDs te krijgen

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

Voorbeeld met krullen:

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

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

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

NOTE

Dit curl bevel kan met om het even welk werkschemastatusin plaats van RUNNING worden gebruikt.

Hoe te om de Titel van het Werkschema te veranderen

Om de Titel van het Werkschema te veranderen die in het 3} lusje van Instanties {van de werkschemaconsole wordt getoond, verzend a POST bevel:

to: http://localhost:4502/etc/workflow/instances/{id}
met de volgende parameters:
- action : de waarde moet als volgt zijn: UPDATE
- workflowTitle: de titel van de workflow

Hoe te om de Titel van het Werkschema te veranderen - REST gebruikend krullen

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

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

Voorbeeld met krullen:

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

NOTE

Zie ook het Leiden de Modellen van het Werkschema.

Een WorkflowSession-object verkrijgen

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

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

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

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

Workflowmodellen maken, lezen of verwijderen

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

De code voor Java- en ECMA-script gebruikt de methode WorkflowSession.createNewModel .
De curl-opdracht geeft rechtstreeks toegang tot het model via de URL.

De gebruikte voorbeelden:

Maak een model (met de id /var/workflow/models/mymodel/jcr:content/model ).
Verwijder het model.

NOTE

Als u het model verwijdert, wordt de eigenschap deleted van het metaData onderliggende knooppunt van het model ingesteld op true .

Verwijderen verwijdert het modelknooppunt niet.

Bij het maken van een model:

De werkstroommodeleditor vereist dat modellen een specifieke knooppuntstructuur hieronder gebruiken /var/workflow/models . Het bovenliggende knooppunt van het model moet van het type cq:Page zijn met een jcr:content -knooppunt met de volgende eigenschapswaarden:
- sling:resourceType: cq/workflow/components/pages/model
- cq:template: /libs/cq/workflow/templates/model
Wanneer u een model maakt, moet u eerst dit knooppunt cq:Page maken en het knooppunt jcr:content ervan gebruiken als het bovenliggende knooppunt van het modelknooppunt.
Het argument id dat sommige methoden vereisen voor het identificeren van het model, is het absolute pad van het modelknooppunt in de opslagplaats:

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

NOTE
Zie hoe te van alle Modellen van het Werkschema een lijst maken.

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

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

NOTE

Wegens het vereiste detailniveau, wordt de krulling niet praktisch geacht voor het creëren van en/of het lezen van een model.

Systeemworkflows filteren bij het controleren van workflowstatus

U kunt WorkflowStatus APIgebruiken om informatie over het werkschemastatuut 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 moeten worden uitgesloten van de relevante resultaten.

U kunt de configuratie OSGiAdobe Granite Workflow PayloadMapCache bijwerken die het werkschema Models specificeert om als systeemwerkschema's worden beschouwd. De standaardworkflowmodellen (runtime) zijn:

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

Stap van de Deelnemer van de auto-Geavanceerde na een Onderbreking

Als u a Deelnemer stap moet auto-vooruit die niet binnen een vooraf bepaalde tijd is voltooid kunt u:

Implementeer een OSGI-gebeurtenislistener om te luisteren naar het maken en wijzigen van taken.
Geef een time-out (deadline) op en maak vervolgens een geplande slingertaak die op dat moment moet worden uitgevoerd.
Schrijf een taakmanager die op de hoogte wordt gebracht wanneer de onderbreking verloopt en de baan teweegbrengt.

Deze manager zal de vereiste actie op de taak nemen als de taak nog niet wordt voltooid

NOTE

De te nemen maatregelen moeten duidelijk omschreven zijn om van deze aanpak gebruik te kunnen maken.

Interactie met workflowinstanties

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

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

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

Beginnend een werkschema

# 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

die van de instanties een lijst maken

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

Hier worden alle instanties vermeld, bijvoorbeeld:

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

NOTE

Zie hoe te om een Lijst van alle Lopende Werkschema'smet hun IDs te krijgen voor het vermelden van instanties met een specifieke status.

Opschorting een werkschema

# 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

Hervatten een werkschema

# 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

Beëindigd een werkschemainstantie

# 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

Interactie met werkitems

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

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

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

die van het Werk van de lijst de Punten van Inbox

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

Details voor werkitems die zich momenteel in de Postvak IN bevinden, worden weergegeven, bijvoorbeeld:

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

delegerend de Punten van het Werk

# 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

De delegatee moet een geldige optie zijn voor de workflowstap.

Voltooiend of vooruitkomend het werkpunten aan de volgende stap

# 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

Luisteren naar workflowgebeurtenissen

Gebruik het OSGi gebeurteniskader om op gebeurtenissen te luisteren die de com.adobe.granite.workflow.event.WorkflowEventklasse bepaalt. Deze klasse biedt ook verschillende nuttige methoden om informatie over het onderwerp van de gebeurtenis te verkrijgen. De methode getWorkItem retourneert bijvoorbeeld het 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;
 }
}

recommendation-more-help