DokumentationAEM 6.4Användarhandbok om utveckling

Skapa arbetsflödesmodeller creating-workflow-models

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

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.
CAUTION
Om du vill använda det klassiska användargränssnittet läser du AEM 6.3-dokumentation för referens.

Du skapar en arbetsflödesmodell för att definiera serie steg som körs när en användare startar arbetsflödet. Du kan också definiera modellegenskaper, t.ex. om arbetsflödet är tillfälligt eller använder flera resurser.

När en användare startar ett arbetsflöde startas en instans; detta är motsvarande körningsmodell som skapades när du Synkronisera dina ändringar.

Skapa ett nytt arbetsflöde creating-a-new-workflow

När du först skapar en ny arbetsflödesmodell innehåller den:

  • Stegen, Flow Start och Flow End.

    Dessa representerar början och slutet av arbetsflödet. Dessa steg är obligatoriska och kan inte redigeras eller tas bort.

  • Ett exempel Deltagare step named Steg 1.

    Det här steget är konfigurerat för att tilldela en arbetsuppgift till arbetsflödesinitieraren. Redigera eller ta bort det här steget och lägg till steg efter behov.

Så här skapar du ett nytt arbetsflöde med redigeraren:

  1. Öppna Workflow Models konsol, genom Tools, Workflow, Models eller, till exempel:

    http://localhost:4502/aem/workflow

  2. Välj Create sedan Create Model.

  3. The Add Workflow Model visas. Ange Title och Name (valfritt) före markering Done.

  4. Den nya modellen listas i Workflow Models konsol.

  5. Välj ditt nya arbetsflöde och använd sedan Edit ​för att öppna den för konfiguration:

    wf-01

NOTE
Om du skapar modeller programmatiskt (med ett crx-paket) kan du även skapa en undermapp i:
/var/workflow/models
Till exempel, /var/workflow/models/prototypes
Den här mappen kan sedan användas för hantera åtkomst till modellerna i den mappen.

Redigera ett arbetsflöde editing-a-workflow

Du kan redigera alla befintliga arbetsflödesmodeller till:

Redigera en Standard eller äldre arbetsflöde har ytterligare ett steg för att säkerställa att säker kopia tas innan ändringarna görs.

När uppdateringarna av arbetsflödet är klara måste du använda Sync till Generate a Runtime Model. Se Synkronisera arbetsflödet för mer information.

Synkronisera arbetsflödet - Skapa en körningsmodell sync-your-workflow-generate-a-runtime-model

Synkronisera (direkt i redigeringsverktygsfältet) genererar ett körningsmodell. Körningsmodellen är den modell som faktiskt används när en användare startar ett arbetsflöde. Om du inte gör det Sync Om du ändrar något kommer ändringarna inte att vara tillgängliga vid körning.

När du (eller någon annan användare) gör ändringar i arbetsflödet måste du använda Sync för att generera en körningsmodell - även när enskilda dialogrutor (till exempel för steg) har egna sparalternativ.

När ändringarna synkroniseras med körningsmodellen (sparad), Synched visas i stället.

Vissa steg har obligatoriska fält och/eller inbyggd validering. När dessa villkor inte uppfylls visas ett fel när du försöker Sync modellen. Om till exempel ingen deltagare har definierats för en Participant steg:

wf-21

Redigera ett standardarbetsflöde eller äldre arbetsflöde för första gången editing-a-default-or-legacy-workflow-for-the-first-time

När du öppnar en Standardmodell och/eller äldre modell för redigering:

  • The Steps webbläsaren är inte tillgänglig (vänster sida).

  • Det finns en Edit åtgärd som finns i verktygsfältet (höger sida).

  • Till att börja med visas modellen och dess egenskaper i skrivskyddat läge som:

    • Standardarbetsflöden finns i /libs
    • Äldre arbetsflöden finns i /etc

Markera Edit kommer att:

  • ta en kopia av arbetsflödet till /conf
  • skapa Steps webbläsare tillgänglig
  • gör att du kan göra ändringar
NOTE
Se Platser för arbetsflödesmodeller för ytterligare information.

wf-22

Lägga till ett steg i en modell adding-a-step-to-a-model

Du måste lägga till steg i modellen för att representera aktiviteten som ska utföras - varje steg utför en specifik aktivitet. Ett urval stegkomponenter är tillgängliga i en AEM.

När du redigerar en modell visas de tillgängliga stegen i de olika grupperna i Steps webbläsare. Till exempel:

wf-10

NOTE
Mer information om de komponenter i det primära steget som installeras med AEM finns i Referens för arbetsflödessteg.

Lägga till ett steg i en modell:

  1. Öppna en befintlig arbetsflödesmodell för redigering. Från Workflows Model väljer du önskad modell och sedan Edit.

  2. Öppna Steps webbläsare, använda Toggle Side Panel, längst till vänster i det övre verktygsfältet. Här kan du:

    • Filter för specifika steg.
    • Använd listruteväljaren för att begränsa markeringen till en viss grupp steg.
    • Välj ikonen Visa beskrivning wf-stepinfo-icon om du vill visa mer information om rätt steg.

    wf-02

  3. Dra lämpliga steg till önskad plats i modellen.

    Till exempel en Participant Step.

    När den har lagts till i flödet kan du konfigurera steget.

    wf-03

  4. Lägg till så många steg eller andra uppdateringar som behövs.

    Vid körning utförs stegen i den ordning som de visas i modellen. När du har lagt till stegkomponenter kan du dra dem till en annan plats i modellen.

    Du kan också kopiera, klippa ut, klistra in, gruppera eller ta bort befintliga steg; som med sidredigeraren.

    Delade steg kan också komprimeras/expanderas med verktygsfältsalternativet: wf-collap-expand-toolbar-icon

  5. Bekräfta ändringarna med Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

Konfigurera ett arbetsflödessteg configuring-a-workflow-step

Du kan Konfigurera och anpassa ett arbetsflödesstegs beteende med Step Properties dialogrutor.

  1. Öppna Step Properties för ett steg:

    • Tryck på steget i arbetsflödesmodellen och välj Configure i komponentens verktygsfält.
    • Dubbelklicka på steget.
    note note
    NOTE
    Mer information om de komponenter i det primära steget som installeras med AEM finns i Referens för arbetsflödessteg.

  2. Konfigurera Step Properties vid behov, Vilka egenskaper som är tillgängliga beror på stegtypen. Det kan också finnas flera tillgängliga flikar. Som standard Participant Step, visas i ett nytt arbetsflöde som Step 1:

    wf-11

  3. Bekräfta uppdateringarna.

  4. Bekräfta ändringarna med Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

Skapa ett tillfälligt arbetsflöde creating-a-transient-workflow

Du kan skapa en Övergående arbetsflödesmodell när du skapar en ny modell eller redigerar en befintlig:

  1. Öppna arbetsflödesmodellen för redigera.

  2. Välj Workflow Model Properties i verktygsfältet.

  3. Aktivera i dialogrutan Transient Workflow (eller inaktivera vid behov):

    wf-07

  4. Bekräfta ändringen med Save & Close; följt av Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

NOTE
När du kör ett arbetsflöde i övergående AEM lagrar ingen arbetsflödeshistorik. Därför Tidslinje visar inte någon information om det arbetsflödet. 🔗

Göra arbetsflödesmodeller tillgängliga i Touch UI make-workflow-models-available-in-touchui

Om det finns en arbetsflödesmodell i det klassiska användargränssnittet, men den saknas på snabbmenyn för val i Timeline pekskärmsgränssnittet och följ sedan konfigurationen för att göra det tillgängligt. Följande steg visar hur du använder arbetsflödesmodellen med namnet Request for Activation.

  1. Bekräfta att modellen inte är tillgänglig i det beröringsaktiverade användargränssnittet. Åtkomst till en resurs med /assets.html/content/dam bana. Välj en resurs. Öppna Timeline i vänster räl. Klicka Start Workflow och bekräfta att Request for Activation Modellen finns inte i popup-listan.

  2. Navigera genom Tools > General > Tagging. Välj Workflow.

  3. Välj Create > Create Tag. Ange Title as DAM och Name as dam. Välj Submit.
    Skapa tagg i arbetsflödesmodell

  4. Navigera till Tools > Workflow > Models. Välj Request for Activation väljer Edit.

  5. Välj Edit öppna Workflow Model Properties. Gå till Basic -fliken.

  6. Lägg till Workflow : DAM till Tags fält. Bekräfta markeringen med bocken.

  7. Bekräfta tillägget av taggen med Save & Close.
    Redigera sidegenskaper för modell

  8. Slutför processen med Sync. Arbetsflödet är nu tillgängligt i det Touch-aktiverade gränssnittet.

Konfigurera ett arbetsflöde för stöd för flera resurser configuring-a-workflow-for-multi-resource-support

Du kan konfigurera en arbetsflödesmodell för Stöd för flera resurser när du skapar en ny modell eller redigerar en befintlig:

  1. Öppna arbetsflödesmodellen för redigera.

  2. Välj Workflow Model Properties i verktygsfältet.

  3. Aktivera i dialogrutan Multi Resource Support (eller inaktivera vid behov):

    wf-08

  4. Bekräfta ändringen med Save & Close; följt av Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

Konfigurera arbetsflödessteg (som visar förlopp för arbetsflöde) configuring-workflow-stages-that-show-workflow-progress

Arbetsflödessteg hjälper dig att visualisera förloppet för ett arbetsflöde när du hanterar uppgifter.

CAUTION
Om arbetsflödesfaser definieras i Page Properties men inte för något av arbetsflödesstegen kommer förloppsindikatorn inte att visa några förlopp (oavsett aktuellt arbetsflödessteg).

De steg som ska vara tillgängliga definieras i arbetsflödesmodellerna. befintliga arbetsflödesmodeller kan uppdateras så att de innehåller scendefinitioner. Du kan definiera valfritt antal steg för arbetsflödesmodellen.

Definiera Stages för ditt arbetsflöde:

  1. Öppna arbetsflödesmodellen för redigering.

  2. Välj Workflow Model Properties i verktygsfältet. Öppna sedan Stages -fliken.

  3. Lägg till (och positionera) det du behöver Stages. Du kan definiera valfritt antal steg för arbetsflödesmodellen.

    Till exempel:

    wf-08-1

  4. Klicka Save & Close för att spara egenskaperna.

  5. Tilldela en fas till varje steg i arbetsflödesmodellen. Till exempel:

    wf-09

    En scen kan tilldelas till mer än ett steg. Till exempel:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    Steg Scen
    Steg 1 Skapa
    Steg 2 Skapa
    Steg 3 Granska
    Steg 4 Godkänn
    Steg 5 Godkänn
    Steg 6 Slutförd

  6. Bekräfta ändringarna med Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

Exportera en arbetsflödesmodell i ett paket exporting-a-workflow-model-in-a-package

  1. Skapa ett nytt paket med Pakethanteraren:

    1. Navigera till Package Manager via Tools, Deployment, Packages.
    2. Klicka på Create Package.
    3. Ange Package Name och annan information efter behov.
    4. Klicka på OK.

  2. Klicka Edit i verktygsfältet i det nya paketet.

  3. Öppna Filters -fliken.

  4. Välj Add Filter och ange sökvägen till arbetsflödesmodellen design:

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

    Klicka på Done.

  5. Välj Add Filter och ange sökvägen till runtime arbetsflödesmodell:

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

    Klicka på Done.

  6. Lägg till ytterligare filter för anpassade skript som används av modellen.

  7. Klicka Save för att bekräfta filterdefinitionerna.

  8. Välj Build i verktygsfältet i paketdefinitionen.

  9. Välj Download i paketets verktygsfält.

Använda arbetsflöden för att bearbeta inskickade formulär using-workflows-to-process-form-submissions

Du kan konfigurera ett formulär som ska bearbetas av det valda arbetsflödet. När användare skickar formuläret skapas en ny arbetsflödesinstans med data från formuläröverföringen som nyttolast.

Så här konfigurerar du arbetsflödet som ska användas med formuläret:

  1. Skapa en ny sida och öppna den för redigering.

  2. Lägg till en Form till sidan.

  3. Konfigurera Form Start -komponent som visades på sidan.

  4. Använd Start Workflow för att välja önskat arbetsflöde bland de tillgängliga:

    wf-12

  5. Bekräfta den nya formulärkonfigurationen med krysset.

Testa arbetsflöden testing-workflows

Det är en god vana att testa ett arbetsflöde för att använda olika typer av nyttolast. inklusive typer som skiljer sig från den för vilken den har utvecklats. Om du t.ex. vill att ditt arbetsflöde ska hantera resurser testar du det genom att ange en sida som nyttolast och se till att den inte orsakar fel.

Testa till exempel ditt nya arbetsflöde på följande sätt:

  1. Starta arbetsflödesmodellen från konsolen.

  2. Definiera Payload och bekräfta.

  3. Utför de åtgärder som behövs så att arbetsflödet fortsätter.

  4. Övervaka loggfilerna medan arbetsflödet körs.

Du kan även konfigurera AEM att visa DEBUG meddelanden i loggfilerna. Se Loggning för mer information och när utvecklingen är klar, ange Log Level tillbaka till Info.

Exempel examples

Exempel: Skapa ett (enkelt) arbetsflöde för att acceptera eller avvisa en begäran om publicering example-creating-a-simple-workflow-to-accept-or-reject-a-request-for-publication

För att illustrera några av möjligheterna att skapa ett arbetsflöde skapar följande exempel en variant av Publish Example arbetsflöde.

  1. Skapa en ny arbetsflödesmodell.

    Det nya arbetsflödet kommer att innehålla:

    • Flow Start
    • Step 1
    • Flow End

  2. Ta bort Step 1 (eftersom det är fel stegtyp för det här exemplet):

    • Klicka på steget och välj Delete i komponentens verktygsfält. Bekräfta åtgärden.

  3. Från Workflow välj stegwebbläsare, dra en Participant Step till arbetsflödet och placera det mellan Flow Start och Flow End.

  4. Så här öppnar du egenskapsdialogrutan:

    • Klicka på deltagarsteget och välj Configure i komponentens verktygsfält.
    • Dubbelklicka på deltagarsteget.

  5. I Common tabbtangenter Validate Content för båda Title och Description.

  6. Öppna User/Group tab:

    • Aktivera Notify user via email.
    • Välj Administrator ( admin) för User/Group fält.
    note note
    NOTE
    För att mejl ska skickas e-posttjänsten och användarkontoinformationen måste konfigureras.

  7. Bekräfta uppdateringarna med en bock.

    Du kommer tillbaka till översikten över arbetsflödesmodellen där deltagarsteget har bytt namn till Validate Content.

  8. Dra en Or Split till arbetsflödet och placera det mellan Validate Content och Flow End.

  9. Öppna Or Split för konfiguration.

  10. Konfigurera:

    • Common: välj 2 Branches
    • Branch 1: välj Default Route.
    • Branch 2: säkerställa Default Route är inte markerat.

  11. Bekräfta dina uppdateringar av OR Split.

  12. Dra en Participant Step till den vänstra grenen öppnar du egenskaperna, anger följande värden och bekräftar sedan ändringarna:

    • Title: Reject Publish Request
    • User/Group: till exempel projects-administrators
    • Notify user via email: Aktivera om du vill att användaren ska meddelas via e-post.

  13. Dra en Process Step till höger gren öppnar du egenskaperna, anger följande värden och bekräftar sedan ändringarna:

    • Title: Publish Page as Requested
    • Process: välj Activate Page. Den här processen publicerar den valda sidan till utgivarinstanserna.

  14. Klicka Sync (redigeringsverktygsfältet) för att generera körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

    Den nya arbetsflödesmodellen ser ut så här:

    wf-13

  15. Använd det här arbetsflödet på sidan så att när användaren flyttar till Complete den Validate Content kan de välja om de vill Publish Page as Requested, eller Reject Publish Request.

    chlimage_1-182

Exempel: Definiera en regel för en OR-delning example-defining-a-rule-for-an-or-split

OR Split kan du använda villkorsstyrda bearbetningssökvägar i arbetsflödet.

Så här definierar du en OR-regel:

  1. Skapa två skript och spara dem i databasen, till exempel under:

    /apps/myapp/workflow/scripts

    note note
    NOTE
    Skripten måste ha en function check() som returnerar ett booleskt värde.

  2. Redigera arbetsflödet och lägg till OR Split till modellen.

  3. Redigera egenskaperna för Branch 1 i OR Split:

    • Definiera det här som Default Route genom att ange Value till true.

    • Som Rule, anger sökvägen till skriptet. Till exempel:

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

    note note
    NOTE
    Du kan ändra grenordningen om det behövs.

  4. Redigera egenskaperna för Branch 2 i OR Split.

    • Som Rule anger du sökvägen till det andra skriptet. Till exempel:

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

  5. Ange egenskaperna för de enskilda stegen i varje gren. Se till att User/Group är inställt.

  6. Klicka Synkronisera (redigeringsverktygsfältet) för att behålla ändringarna i körningsmodellen.

    Se Synkronisera arbetsflödet för mer information.

Funktionskontroll() function-check

NOTE
Se Använda ECMAScript.

Följande exempelskript returnerar true om noden är en JCR_PATH finns under /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;
     }
}

Exempel: Anpassad aktiveringsbegäran example-customized-request-for-activation

Du kan anpassa alla färdiga arbetsflöden. Om du vill ha ett anpassat beteende lägger du över information om rätt arbetsflöde.

Till exempel, Request for Activation. Det här arbetsflödet används för att publicera sidor i Sites och aktiveras automatiskt när en innehållsförfattare inte har rätt replikeringsbehörighet. Se Anpassa sidredigering - Anpassa arbetsflödet för begäran om aktivering för mer information.

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