DocumentatieAEM 6.4Handleiding voor ontwikkeling

Workflowmodellen maken creating-workflow-models

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Developer
CAUTION
AEM 6.4 heeft het einde van de uitgebreide ondersteuning bereikt en deze documentatie wordt niet meer bijgewerkt. Raadpleeg voor meer informatie onze technische ondersteuningsperioden. Ondersteunde versies zoeken hier.
CAUTION
Voor gebruik van de klassieke interface raadpleegt u de AEM 6.3-documentatie ter referentie.

U maakt een workflowmodel om de reeks stappen te definiëren die worden uitgevoerd wanneer een gebruiker de workflow start. U kunt ook modeleigenschappen definiëren, zoals of de workflow van voorbijgaande aard is of meerdere bronnen gebruikt.

Wanneer een gebruiker een workflow start, wordt een instantie gestart; dit is het corresponderende runtimemodel dat is gemaakt toen u Synchroniseren uw wijzigingen.

Nieuwe workflow maken creating-a-new-workflow

Wanneer u voor het eerst een nieuw workflowmodel maakt, bevat dit model:

  • de stappen, Flow Start en Flow End.

    Deze vertegenwoordigen het begin en einde van de workflow. Deze stappen zijn vereist en kunnen niet worden bewerkt of verwijderd.

  • Een voorbeeld Deelnemer stap benoemd Stap 1.

    Deze stap wordt gevormd om een het werkpunt aan de werkschemainitiatiefnemer toe te wijzen. Bewerk of verwijder deze stap en voeg desgewenst stappen toe.

Een nieuwe workflow maken met de editor:

  1. Open de Workflow Models console; door Tools, Workflow, Models of, bijvoorbeeld:

    http://localhost:4502/aem/workflow

  2. Selecteren Create vervolgens Create Model.

  3. De Add Workflow Model wordt weergegeven. Voer de Title en Name (optioneel) voordat u selecteert Done.

  4. Het nieuwe model wordt vermeld in Workflow Models console.

  5. Selecteer uw nieuwe workflow en gebruik Edit ​openen voor configuratie:

    wf-01

NOTE
Als u met programmacode modellen maakt (met behulp van een crx-pakket), kunt u ook een submap maken binnen:
/var/workflow/models
Bijvoorbeeld, /var/workflow/models/prototypes
Deze map kan vervolgens worden gebruikt voor toegang tot de modellen in die map beheren.

Een workflow bewerken editing-a-workflow

U kunt elk bestaand workflowmodel bewerken in:

Een Standaard of Verouderd (out-of-the-box) workflow een extra stap heeft om ervoor te zorgen dat een veilige kopie wordt gebruikt voordat de wijzigingen worden aangebracht.

Wanneer updates van uw workflow zijn voltooid, moet u Sync tot Generate a Runtime Model. Zie Uw workflow synchroniseren voor meer informatie.

Uw workflow synchroniseren - Een runtimemodel genereren sync-your-workflow-generate-a-runtime-model

Synchroniseren (rechts op de editor-werkbalk) genereert een runtimemodel. Het runtimemodel is het model dat daadwerkelijk wordt gebruikt wanneer een gebruiker een workflow start. Als u dat niet doet Sync uw wijzigingen, dan zijn de wijzigingen niet beschikbaar bij uitvoering.

Wanneer u (of een andere gebruiker) wijzigingen aanbrengt in de workflow, moet u Sync om een runtimemodel te genereren - zelfs als afzonderlijke dialoogvensters (bijvoorbeeld voor stappen) hun eigen opslagopties hebben.

Wanneer de wijzigingen worden gesynchroniseerd met het (opgeslagen) runtimemodel, Synched wordt weergegeven.

Sommige stappen hebben verplichte velden en/of ingebouwde validatie. Wanneer niet aan deze voorwaarden wordt voldaan, wordt een fout weergegeven wanneer u probeert Sync het model. Wanneer bijvoorbeeld geen deelnemer is gedefinieerd voor een Participant stap:

wf-21

Een standaardworkflow of oudere workflow voor het eerst bewerken editing-a-default-or-legacy-workflow-for-the-first-time

Wanneer u een Standaard en/of verouderd model voor bewerking:

  • De Steps browser is niet beschikbaar (linkerkant).

  • Er is een Edit in de werkbalk (rechts) beschikbaar.

  • In eerste instantie worden het model en de eigenschappen ervan in de modus Alleen-lezen weergegeven als:

    • Standaardworkflows bevinden zich in /libs
    • Oudere workflows bevinden zich in /etc

Selecteren Edit zal:

  • neem een kopie van de workflow naar /conf
  • de Steps browser beschikbaar
  • laten u toe om veranderingen aan te brengen
NOTE
Zie Locaties van workflowmodellen voor nadere informatie.

wf-22

Een stap toevoegen aan een model adding-a-step-to-a-model

U moet stappen aan uw model toevoegen om de uit te voeren activiteit te vertegenwoordigen - elke stap voert een specifieke activiteit uit. Een selectie van stapcomponenten is beschikbaar in een standaard AEM instantie.

Wanneer u een model bewerkt, worden de beschikbare stappen weergegeven in de verschillende groepen van de Steps browser. Bijvoorbeeld:

wf-10

NOTE
Voor informatie over de primaire stapcomponenten die met AEM worden geïnstalleerd, zie Referentie workflowstappen.

Een stap toevoegen aan een model:

  1. Open een bestaand workflowmodel voor bewerking. Van de Workflows Model -console, selecteert u het vereiste model en Edit.

  2. Open de Steps browser; gebruiken Toggle Side Panel helemaal links van de bovenste werkbalk. Hier kunt u:

    • Filter voor specifieke stappen.
    • Gebruik de keuzelijst om de selectie te beperken tot een specifieke groep stappen.
    • Selecteer het pictogram Beschrijving tonen wf-stepinfo-icon voor meer informatie over de juiste stap.

    wf-02

  3. Sleep de desbetreffende stap(en) naar de gewenste locatie in het model.

    Bijvoorbeeld een Participant Step.

    Nadat het aan de stroom is toegevoegd kunt u vorm de stap.

    wf-03

  4. Voeg zo veel stappen, of andere updates toe, zoals vereist.

    Tijdens de uitvoering worden de stappen uitgevoerd in de volgorde waarin ze in het model worden weergegeven. Nadat u de onderdelen met stappen hebt toegevoegd, kunt u deze naar een andere locatie in het model slepen.

    U kunt ook bestaande stappen kopiëren, knippen, plakken, groeperen of verwijderen. zoals bij de pagina-editor.

    Gesplitste stappen kunnen ook worden samengevouwen/uitgevouwen met de werkbalkoptie: wf-collapse-toolbar-icon

  5. Wijzigingen bevestigen met Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

Een workflowstap configureren configuring-a-workflow-step

U kunt Configureren en pas het gedrag van een werkschemastap aan gebruikend Step Properties dialoogvensters.

  1. Als u het dialoogvenster Step Properties een van de volgende stappen:

    • Tik op de stap in het workflowmodel en selecteer Configure op de werkbalk van de component.
    • Dubbelklik op de stap.
    note note
    NOTE
    Voor informatie over de primaire stapcomponenten die met AEM worden geïnstalleerd, zie Referentie workflowstappen.

  2. Configureer de Step Properties indien nodig; Welke eigenschappen beschikbaar zijn, is afhankelijk van het type stap. Er kunnen ook verschillende tabbladen beschikbaar zijn. De standaardinstelling Participant Step, in een nieuwe workflow presenteren als Step 1:

    wf-11

  3. Bevestig uw updates met de tik.

  4. Wijzigingen bevestigen met Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

Een tijdelijke workflow maken creating-a-transient-workflow

U kunt een Voorzichtig workflowmodel bij het maken van een nieuw model of bij het bewerken van een bestaand model:

  1. Het workflowmodel openen voor bewerken.

  2. Selecteren Workflow Model Properties op de werkbalk.

  3. Activeer in het dialoogvenster Transient Workflow (of deactiveren indien vereist):

    wf-07

  4. De wijziging bevestigen met Save & Close; gevolgd door Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

NOTE
Wanneer u een workflow uitvoert in transient AEM slaat geen workflowgeschiedenis op. Daarom Tijdlijn geeft geen informatie weer die betrekking heeft op die workflow. 🔗

Workflowmodellen beschikbaar stellen in Touch UI make-workflow-models-available-in-touchui

Als een workflowmodel aanwezig is in de klassieke gebruikersinterface, maar ontbreekt in het pop-upmenu Selectie in het dialoogvenster Timeline rail van Touch UI, dan volg de configuratie om het ter beschikking te stellen. De volgende stappen illustreren het gebruiken van het geroepen werkschemamodel Request for Activation.

  1. Bevestig dat het model niet beschikbaar is in een interface met aanraakbediening. Middelen benaderen met /assets.html/content/dam pad. Selecteer een element. Openen Timeline in linkerspoor. Klikken Start Workflow en bevestigt dat de Request for Activation model is niet aanwezig in de pop-uplijst.

  2. Navigeren door Tools > General > Tagging. Selecteer Workflow.

  3. Selecteer Create > Create Tag. Set Title als DAM en Name als dam. Selecteer Submit.
    Tag maken in workflowmodel

  4. Ga naar Tools > Workflow > Models. Selecteren Request for Activation selecteert u vervolgens Edit.

  5. Selecteren Edit en vervolgens openen Workflow Model Properties. Ga naar de Basic tab.

  6. Toevoegen Workflow : DAM tot Tags veld. Bevestig de selectie met de controle (kruis).

  7. De toevoeging van de tag bevestigen met Save & Close.
    Pagina-eigenschappen van model bewerken

  8. Voltooi het proces met Sync. De workflow is nu beschikbaar in de interface voor aanraakbediening.

Een workflow configureren voor ondersteuning van meerdere bronnen configuring-a-workflow-for-multi-resource-support

U kunt een workflowmodel configureren voor Ondersteuning voor meerdere bronnen bij het maken van een nieuw model of door een bestaand model te bewerken:

  1. Het workflowmodel openen voor bewerken.

  2. Selecteren Workflow Model Properties op de werkbalk.

  3. Activeer in het dialoogvenster Multi Resource Support (of deactiveren indien vereist):

    wf-08

  4. De wijziging bevestigen met Save & Close; gevolgd door Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

Werkstroomfasen configureren (die de voortgang van de workflow weergeven) configuring-workflow-stages-that-show-workflow-progress

Werkstroomfasen Help de voortgang van een workflow bij het uitvoeren van taken te visualiseren.

CAUTION
Als werkstroomfasen zijn gedefinieerd in Page Properties, maar niet gebruikt voor de workflowstappen, wordt op de voortgangsbalk geen voortgang weergegeven (ongeacht de huidige workflowstap).

De stadia die beschikbaar moeten zijn, worden gedefinieerd in de workflowmodellen; bestaande workflowmodellen kunnen worden bijgewerkt met werkgebieddefinities. U kunt een willekeurig aantal fasen voor het workflowmodel definiëren.

Om te bepalen Stages voor uw workflow:

  1. Open uw workflowmodel voor bewerking.

  2. Selecteren Workflow Model Properties op de werkbalk. Open vervolgens het dialoogvenster Stages tab.

  3. Voeg (en plaats) uw vereiste toe Stages. U kunt een willekeurig aantal fasen voor het workflowmodel definiëren.

    Bijvoorbeeld:

    wf-08-1

  4. Klikken Save & Close om de eigenschappen op te slaan.

  5. Wijs een werkgebied aan elk van de stappen in het werkschemamodel toe. Bijvoorbeeld:

    wf-09

    Een werkgebied kan aan meerdere stappen worden toegewezen. Bijvoorbeeld:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    Stap Werkgebied
    Stap 1 Maken
    Stap 2 Maken
    Stap 3 Controleren
    Stap 4 Goedkeuren
    Stap 5 Goedkeuren
    Stap 6 Voltooid

  6. Wijzigingen bevestigen met Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

Een workflowmodel exporteren in een pakket exporting-a-workflow-model-in-a-package

  1. Een nieuw pakket maken met de opdracht Pakketbeheer:

    1. Navigeer aan de Manager van het Pakket door Tools, Deployment, Packages.
    2. Klik op Create Package.
    3. Geef de Package Name en alle andere gegevens die nodig zijn.
    4. Klik op OK.

  2. Klikken Edit op de werkbalk van het nieuwe pakket.

  3. Open de Filters tab.

  4. Selecteren Add Filter en geef het pad van uw workflowmodel op ontwerp:

    /conf/global/settings/workflow/models/<*your-model-name*>

    Klik op Done.

  5. Selecteren Add Filter en geef het pad van uw runtime workflowmodel:

    /var/workflow/models/<*your-model-name*>

    Klik op Done.

  6. Voeg extra filters toe voor om het even welke douanescripts die door uw model worden gebruikt.

  7. Klikken Save om uw filterdefinities te bevestigen.

  8. Selecteren Build op de werkbalk van de pakketdefinitie.

  9. Selecteren Download op de pakketwerkbalk.

Workflows gebruiken om formulierverzendingen te verwerken using-workflows-to-process-form-submissions

U kunt een formulier configureren voor verwerking door de geselecteerde workflow. Wanneer gebruikers het formulier verzenden, wordt een nieuwe werkstroominstantie gemaakt met de gegevens van het verzenden van het formulier als lading.

U configureert als volgt de workflow die met het formulier moet worden gebruikt:

  1. Maak een nieuwe pagina en open deze voor bewerking.

  2. Voeg een Form naar de pagina.

  3. Configureer de Form Start die op de pagina werden weergegeven.

  4. Gebruiken Start Workflow om de gewenste workflow te selecteren uit de beschikbare werkstromen:

    wf-12

  5. Bevestig de nieuwe formulierconfiguratie met de tik.

Testworkflows testing-workflows

Het is een goede praktijk wanneer het testen van een werkschema om een verscheidenheid van ladingstypes te gebruiken; met inbegrip van typen die verschillen van de soorten waarvoor zij is ontwikkeld. Als u bijvoorbeeld van plan bent om in uw workflow te werken met Elementen, test u deze door een Pagina in te stellen als een payload en controleer of er geen fouten optreden.

Test bijvoorbeeld de nieuwe workflow als volgt:

  1. Uw workflowmodel starten vanuit de console.

  2. Definieer de Payload en bevestigen.

  3. Voer de vereiste handelingen uit zodat de workflow doorgaat.

  4. Controleer de logbestanden terwijl de workflow wordt uitgevoerd.

U kunt ook AEM configureren voor weergave DEBUG in de logbestanden. Zie Logboekregistratie voor meer informatie en wanneer de ontwikkeling is voltooid, stelt u de Log Level terug naar Info.

Voorbeelden examples

Voorbeeld: Een (eenvoudige) workflow maken om een publicatieaanvraag te accepteren of af te wijzen example-creating-a-simple-workflow-to-accept-or-reject-a-request-for-publication

Om enkele mogelijkheden voor het maken van een workflow te illustreren, maakt u in het volgende voorbeeld een variatie van de optie Publish Example workflow.

  1. Een nieuw workflowmodel maken.

    De nieuwe workflow bevat:

    • Flow Start
    • Step 1
    • Flow End

  2. Verwijderen Step 1 (omdat dit het verkeerde staptype voor dit voorbeeld is):

    • Klik op de stap en selecteer Delete op de werkbalk van de component. Bevestig de handeling.

  3. Van de Workflow Selecteer de gewenste stappen in de browser en sleep een Participant Step op de werkstroom te plaatsen en deze tussen Flow Start en Flow End.

  4. U opent als volgt het dialoogvenster Eigenschappen:

    • Klik op de deelnemersstap en selecteer Configure op de werkbalk van de component.
    • Dubbelklik op de stap voor deelnemers.

  5. In de Common tabs openen Validate Content voor beide Title en Description.

  6. Open de User/Group tab:

    • Activeren Notify user via email.
    • Selecteren Administrator ( admin) voor de User/Group veld.
    note note
    NOTE
    Voor te verzenden e-mails: de postdienst en de details van de gebruikersrekening moeten worden gevormd.

  7. Bevestig de updates met de tik.

    U wordt teruggestuurd naar het overzicht van het workflowmodel, waar de naam van de deelnemer is gewijzigd in Validate Content.

  8. Sleep een Or Split op de werkstroom te plaatsen en deze tussen Validate Content en Flow End.

  9. Open de Or Split voor configuratie.

  10. Configureren:

    • Common: selecteren 2 Branches
    • Branch 1: selecteren Default Route.
    • Branch 2: waarborgen Default Route is niet geselecteerd.

  11. Bevestig uw updates aan OR Split.

  12. Sleep een Participant Step Open de eigenschappen in de linkervertakking, geef de volgende waarden op en bevestig de wijzigingen:

    • Title: Reject Publish Request
    • User/Group: bijvoorbeeld: projects-administrators
    • Notify user via email: Activeer deze functie om de gebruiker per e-mail op de hoogte te stellen.

  13. Sleep een Process Step Open de eigenschappen op de rechtervertakking, geef de volgende waarden op en bevestig de wijzigingen:

    • Title: Publish Page as Requested
    • Process: selecteren Activate Page. Dit proces publiceert de geselecteerde pagina naar de uitgeversinstanties.

  14. Klikken Sync (editor-werkbalk) om het runtimemodel te genereren.

    Zie Uw workflow synchroniseren voor meer informatie.

    Uw nieuwe workflowmodel ziet er als volgt uit:

    wf-13

  15. Pas deze workflow toe op de pagina, zodat wanneer de gebruiker naar Complete de Validate Content stap, kunnen ze selecteren of ze Publish Page as Requested, of Reject Publish Request.

    chlimage_1-182

Voorbeeld: Een regel definiëren voor een OR-splitsing example-defining-a-rule-for-an-or-split

OR Split Met de stappen kunt u voorwaardelijke verwerkingspaden in uw workflow opnemen.

Een OR-regel definiëren:

  1. Maak twee scripts en sla deze op in de repository, bijvoorbeeld onder:

    /apps/myapp/workflow/scripts

    note note
    NOTE
    De scripts moeten een function check() dat een booleaanse waarde retourneert.

  2. De workflow bewerken en de OR Split op het model.

  3. Eigenschappen van Branch 1 van de OR Split:

    • Hiermee definieert u dit als de Default Route door de Value tot true.

    • Als Rule, stelt u het pad naar het script in. Bijvoorbeeld:

      /apps/myapp/workflow/scripts/myscript1.ecma

    note note
    NOTE
    U kunt de vertakkingsvolgorde desgewenst wijzigen.

  4. De eigenschappen van het gereedschap Branch 2 van de OR Split.

    • Als Rule, stelt u het pad in op het andere script. Bijvoorbeeld:

      /apps/myapp/workflow/scripts/myscript2.ecma

  5. Stel de eigenschappen van de afzonderlijke stappen in elke vertakking in. Zorg ervoor dat de User/Group is ingesteld.

  6. Klikken Synchroniseren (editor-werkbalk) om uw wijzigingen in het runtimemodel voort te zetten.

    Zie Uw workflow synchroniseren voor meer informatie.

Functie check() function-check

NOTE
Zie ECMAScript gebruiken.

Het volgende voorbeeldscript retourneert true als het knooppunt een JCR_PATH onder /content/we-retail/us/en:

function check() {
    if (workflowData.getPayloadType() == "JCR_PATH") {
      var path = workflowData.getPayload().toString();
      var node = jcrSession.getItem(path);

      if (node.getPath().indexOf("/content/we-retail/us/en") >= 0) {
       return true;
      } else {
       return false;
      }
     } else {
      return false;
     }
}

Voorbeeld: Aangepast verzoek om activering example-customized-request-for-activation

U kunt om het even welke uit-van-de-doos workflows aanpassen. Voor aangepast gedrag bedekt u de details van de juiste workflow.

Bijvoorbeeld, Request for Activation. Deze workflow wordt gebruikt voor het publiceren van pagina's binnen Sites en wordt automatisch geactiveerd wanneer een auteur van de inhoud niet de juiste replicatierechten heeft. Zie Paginaontwerp aanpassen - De activeringsworkflow aanpassen voor nadere bijzonderheden.

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e