Skapa arbetsflödesmodeller creating-workflow-models

Last update: Sat Jul 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Utveckling

Skapat för:

Utvecklare

CAUTION

Information om hur du använder det klassiska användargränssnittet finns i AEM 6.3-dokumentationen.

Du skapar en arbetsflödesmodell för att definiera serien med 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. Det här är motsvarande körningsmodell som skapades när du Synkroniserar dina ändringar.

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

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

Stegen Flödesstart och Flödesslut.
Dessa representerar början och slutet av arbetsflödet. Dessa steg är obligatoriska och kan inte redigeras/tas bort.
Ett exempel på Deltagare-steg med namnet 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 arbetsflöde med redigeraren:

Öppna konsolen Arbetsflödesmodeller, via Verktyg, Arbetsflöde, Modeller eller, till exempel: https://localhost:4502/aem/workflow
Välj Skapa och sedan Skapa modell.
Dialogrutan Lägg till arbetsflödesmodell visas. Ange Titel och Namn (valfritt) innan du väljer Klar.
Den nya modellen visas i konsolen Arbetsflödesmodeller.
Välj ditt nya arbetsflöde och använd sedan Redigera för att öppna det för konfiguration:

NOTE

Om du skapar modeller programmatiskt (med ett crx-paket) kan du även skapa en undermapp i:

/var/workflow/models

Exempel: /var/workflow/models/prototypes

Den här mappen kan sedan användas för att hantera åtkomst till modellerna i den mappen.

Redigera ett arbetsflöde editing-a-workflow

Du kan redigera alla befintliga arbetsflödesmodeller till:

definiera steg och deras parametrar
konfigurera arbetsflödesegenskaper, inklusive faser, om arbetsflödet är tillfälligt och/eller använder flera resurser

Om du redigerar ett standardarbetsflöde och/eller äldre arbetsflöde (ej ikryssat) får du ett ytterligare steg som säkerställer att en säker kopia utförs innan ändringarna görs.

När uppdateringarna av arbetsflödet är klara måste du använda Synkronisera för att generera en körningsmodell. Mer information finns i Synkronisera arbetsflödet.

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

Synkronisering (direkt i redigeringsverktygsfältet) genererar en körningsmodell. Körningsmodellen är den modell som faktiskt används när en användare startar ett arbetsflöde. Om du inte Synkroniserar dina ändringar är ändringarna inte tillgängliga vid körning.

När du (eller någon annan användare) gör några ändringar i arbetsflödet måste du använda Synkronisera 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) visas Synkroniserad 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 Synkronisera modellen. Om ingen deltagare har definierats för ett Deltagare -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:

Stegwebbläsaren är inte tillgänglig (vänster sida).
Det finns en Redigera-åtgärd tillgänglig 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
  Om du väljer Redigera kommer du att:
ta en kopia av arbetsflödet till /conf
göra stegwebbläsaren tillgänglig
gör att du kan göra ändringar

NOTE

Mer information finns i Platser för arbetsflödesmodeller.

wf-22

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

Lägg 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 stegwebbläsaren. Till exempel:

wf-10

NOTE

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

Så här lägger du till steg i arbetsflödesmodellen:

Öppna en befintlig arbetsflödesmodell för redigering. Välj önskad modell från arbetsflödesmodellkonsolen och sedan Redigera.
Öppna stegwebbläsaren och använd växlingspanelen längst till vänster i det övre verktygsfältet. Här kan du:
- Filtrera för specifika steg.
- Använd listruteväljaren för att begränsa markeringen till en viss grupp steg.
- Välj ikonen Visa beskrivning om du vill visa mer information om det aktuella steget.
Dra lämpliga steg till önskad plats i modellen.

Exempel: ett deltagarsteg.

När du har lagt till i flödet kan du konfigurera steget.
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:
Bekräfta ändringarna med Synkronisera (redigeringsverktygsfältet) för att generera körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

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

Du kan konfigurera och anpassa beteendet för ett arbetsflödessteg med hjälp av dialogrutorna Stegegenskaper .

Så här öppnar du dialogrutan Stegegenskaper för ett steg:

Klicka på steget* *i arbetsflödesmodellen och välj Konfigurera i komponentverktygsfältet.
Dubbelklicka på steget.

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

Konfigurera stegegenskaperna efter behov. Vilka egenskaper som är tillgängliga beror på stegtypen. Det kan också finnas flera tillgängliga flikar. Standardsteget Deltagare, som finns i ett nytt arbetsflöde, är till exempel Step 1:
Bekräfta uppdateringarna.
Bekräfta ändringarna med Synkronisera (redigeringsverktygsfältet) för att generera körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

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

Du kan skapa en tillfällig arbetsflödesmodell när du skapar en modell, eller genom att redigera en befintlig:

Öppna arbetsflödesmodellen för redigering.
Välj Egenskaper för arbetsflödesmodell i verktygsfältet.
Aktivera Transient Workflow (eller inaktivera om det behövs) i dialogrutan:
Bekräfta ändringen med Spara och stäng; följt av Synkronisera (redigeringsverktygsfältet) för att generera körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

NOTE

När du kör ett arbetsflöde i läget transient sparas ingen arbetsflödeshistorik AEM. Därför visar Tidslinjen ingen information som är relaterad till det arbetsflödet.

Göra arbetsflödesmodeller tillgängliga i Touch UI classic2touchui

Om det finns en arbetsflödesmodell i det klassiska användargränssnittet, men den saknas på snabbmenyn för val i Timeline-listen i Touch UI, följer du konfigurationen för att göra den tillgänglig. Följande steg visar hur du använder arbetsflödesmodellen Request for Activation.

Bekräfta att modellen inte är tillgänglig i det beröringsaktiverade användargränssnittet. Åtkomst till en resurs med sökvägen /assets.html/content/dam. Välj en resurs. Öppna Timeline i den vänstra listen. Klicka på Start Workflow och bekräfta att modellen Request for Activation inte finns i popup-listan.
Navigera genom Tools > General > Tagging. Välj Workflow.
Välj Create > Create Tag. Ange Title som DAM och Name som dam. Välj Submit.
Navigera till Tools > Workflow > Models. Välj Request for Activation och sedan Edit.
Välj Edit, öppna menyn Page Information och gå sedan till fliken Open Properties (om den inte redan är öppen).Basic
Lägg till Workflow : DAM i fältet Tags. Bekräfta markeringen med bocken.
Bekräfta tillägget av taggen med Save & Close.
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 Multi Resource Support när du skapar en modell, eller genom att redigera en befintlig:

Öppna arbetsflödesmodellen för redigering.
Välj Egenskaper för arbetsflödesmodell i verktygsfältet.
Aktivera Multi Resource Support (eller inaktivera vid behov) i dialogrutan:
Bekräfta ändringen med Spara och stäng; följt av Synkronisera (redigeringsverktygsfältet) för att generera körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

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

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

CAUTION

Om arbetsflödesfaser definieras i Sidegenskaper, men inte används för något av arbetsflödesstegen, visas inga förlopp i förloppsindikatorn (oavsett aktuellt arbetsflödessteg).

De steg som ska vara tillgängliga definieras i arbetsflödesmodellerna. Befintliga arbetsflödesmodeller kan uppdateras för att inkludera scendefinitioner. Du kan definiera valfritt antal steg för arbetsflödesmodellen.

Så här definierar du faser för ditt arbetsflöde:

Öppna arbetsflödesmodellen för redigering.
Välj Egenskaper för arbetsflödesmodell i verktygsfältet. Öppna sedan fliken Steg.
Lägg till (och placera) de steg som krävs. Du kan definiera valfritt antal steg för arbetsflödesmodellen.

Till exempel:
Klicka på Spara och stäng för att spara egenskaperna.

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	Complete

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

Mer information finns i Synkronisera arbetsflödet.

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

Så här exporterar du en arbetsflödesmodell i ett paket:

Skapa ett paket med hjälp av pakethanteraren:
1. Navigera till pakethanteraren via Verktyg, Distribution, Paket.
2. Klicka på Skapa paket.
3. Ange paketnamnet och annan information efter behov.
4. Klicka på OK.
Klicka på Redigera i verktygsfältet för det nya paketet.
Öppna fliken Filter.
Välj Lägg till filter och ange sökvägen till arbetsflödesmodellen design:

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

Klicka på Klar.
Välj Lägg till filter och ange sökvägen till arbetsflödesmodellen för miljön:

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

Klicka på Klar.
Lägg till ytterligare filter för anpassade skript som används av modellen.
Klicka på Spara för att bekräfta filterdefinitionerna.
Välj Build i verktygsfältet för paketdefinitionen.
Välj Hämta 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:

Skapa en sida och öppna den för redigering.
Lägg till en Form-komponent på sidan.
Konfigurera komponenten Formulärstart som visades på sidan.
Använd Starta arbetsflöde för att välja önskat arbetsflöde bland de tillgängliga:
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 som arbetsflödet har utvecklats för. Om du t.ex. vill att ditt arbetsflöde ska hantera Assets 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:

Starta arbetsflödesmodellen från konsolen.
Definiera nyttolasten och bekräfta.
Utför de åtgärder som behövs så att arbetsflödet fortsätter.
Övervaka loggfilerna medan arbetsflödet körs.

Du kan också konfigurera AEM så att DEBUG -meddelanden visas i loggfilerna. Mer information finns i Loggning och när utvecklingen är klar anger du loggnivån till Info igen.

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 arbetsflödet Publish Example.

Skapa en arbetsflödesmodell.

Det nya arbetsflödet kommer att innehålla:
- Flödesstart
- Step 1
- Flödesslut
Ta bort Step 1 (eftersom det är fel stegtyp för det här exemplet):
- Klicka på steget och välj Ta bort i komponentens verktygsfält. Bekräfta åtgärden.
Dra ett Deltagarsteg från markeringen Arbetsflöde i stegwebbläsaren till arbetsflödet och placera det mellan Flödesstart och Flödesslut.
Så här öppnar du egenskapsdialogrutan:
- Klicka på deltagarsteget och välj Konfigurera i komponentens verktygsfält.
- Dubbelklicka på deltagarsteget.
På fliken Allmänt anger du Validate Content för både Titel och Beskrivning.

Öppna fliken Användare/grupp:

Aktivera Meddela användare via e-post.
Välj Administrator ( admin) för fältet Användare/grupp.

note note
NOTE
E-posttjänsten och användarkontoinformationen måste konfigureras för att e-postmeddelanden ska kunna skickas.

Bekräfta uppdateringarna med en bock.

Du återgår till översikten över arbetsflödesmodellen där deltagarsteget har bytt namn till Validate Content.
Dra en eller delad till arbetsflödet och placera den mellan Validate Content och Flödesslut.
Öppna eller dela för konfiguration.
Konfigurera:
- Allmänt: ange delningsnamnet.
- Förgrening 1: välj Standardflöde.
- Förgrening 2: kontrollera att Standardflöde inte är markerat.
Bekräfta dina uppdateringar av ELLER Dela.
Dra ett deltagarsteg till den vänstra grenen, öppna egenskaperna, ange följande värden och bekräfta ändringarna:
- Titel: Reject Publish Request
- Användare/grupp: till exempel projects-administrators
- Meddela användaren via e-post: Aktivera om du vill att användaren ska meddelas via e-post.
Dra ett processsteg till den högra grenen, öppna egenskaperna, ange följande värden och bekräfta sedan ändringarna:
- Titel: Publish Page as Requested
- Process: välj Activate Page. Den här processen publicerar den valda sidan till utgivarinstanserna.
Klicka på Synkronisera (redigeringsverktygsfältet) för att generera körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

Den nya arbetsflödesmodellen ser ut så här:
Använd det här arbetsflödet på sidan så att användaren kan välja om han/hon vill Publish Page as Requested eller Avvisa Publish Request när han/hon går till Complete eller Validera innehåll.

Exempel: Definiera en regel för en OR-delning med ECMA-skript defineruleecmascript

Med stegen ELLER Dela kan du infoga villkorsstyrda bearbetningssökvägar i arbetsflödet.

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

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

/apps/myapp/workflow/scripts

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

Redigera arbetsflödet och lägg till ELLER Dela i modellen.

Redigera egenskaperna för grenen i ELLER Dela:

Definiera detta som standardflöde genom att ange värde till true.
Ange sökvägen till skriptet som Regel. Till exempel:

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

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

Redigera egenskaperna för grenen i ELLER Dela.
- Ange sökvägen till det andra skriptet som Regel. Till exempel:
  
  /apps/myapp/workflow/scripts/myscript2.ecma
Ange egenskaperna för de enskilda stegen i varje gren. Kontrollera att Användare/grupp har angetts.
Klicka på Synkronisera (redigeringsverktygsfältet) om du vill behålla ändringarna i körningsmodellen.

Mer information finns i Synkronisera arbetsflödet.

Funktionskontroll() function-check

NOTE

Se Använda ECMAScript.

Följande exempelskript returnerar true om noden är en JCR_PATH som 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.

Exempel: Begäran om aktivering. Det här arbetsflödet används för att publicera sidor i platser och aktiveras automatiskt när en innehållsförfattare inte har rätt replikeringsbehörighet. Mer information finns i Anpassa sidredigering - Anpassa arbetsflödet för begäran om aktivering.

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2