DocumentazioneAEM 6.5Guida utente

Creazione di modelli di flussi di lavoro

14 luglio 2024
  • Argomenti:
  • Sviluppo

Creato per:

  • Sviluppatore
CAUTION
Per informazioni sull'utilizzo dell'interfaccia classica, consultare la documentazione di AEM 6.3.

È possibile creare un modello di flusso di lavoro per definire la serie di passaggi eseguiti all'avvio del flusso di lavoro da parte di un utente. Puoi anche definire le proprietà del modello, ad esempio se il flusso di lavoro è transitorio o utilizza più risorse.

Quando un utente avvia un flusso di lavoro, viene avviata un'istanza; si tratta del modello di runtime corrispondente, creato quando Sincronizza le modifiche.

Creazione di un nuovo flusso di lavoro

La prima volta che crei un modello di flusso di lavoro, contiene:

  • Passaggi: Inizio flusso e Fine flusso.
    Questi rappresentano l’inizio e la fine del flusso di lavoro. Questi passaggi sono necessari e non possono essere modificati/rimossi.
  • Un passaggio Partecipante di esempio denominato Passaggio 1.
    Questo passaggio è configurato per assegnare un elemento di lavoro all'iniziatore del flusso di lavoro. Modifica o elimina questo passaggio e aggiungi i passaggi richiesti.

Per creare un flusso di lavoro con l’editor:

  1. Apri la console Modelli flusso di lavoro tramite Strumenti, Flusso di lavoro, Modelli o, ad esempio: https://localhost:4502/aem/workflow
  2. Seleziona Crea, quindi Crea modello.
  3. Viene visualizzata la finestra di dialogo Aggiungi modello flusso di lavoro. Immetti Titolo e Nome (facoltativo) prima di selezionare Fine.
  4. Il nuovo modello è elencato nella console Modelli flusso di lavoro.
  5. Seleziona il nuovo flusso di lavoro, quindi utilizza Modifica per aprirlo per la configurazione:
    wf-01
NOTE
Se crei modelli a livello di programmazione (utilizzando un pacchetto crx), puoi anche creare una sottocartella all’interno di:
/var/workflow/models
Ad esempio /var/workflow/models/prototypes
Questa cartella può quindi essere utilizzata per gestire l'accesso ai modelli in tale cartella.

Modifica di un flusso di lavoro

Puoi modificare qualsiasi modello di flusso di lavoro esistente in:

  • definisci i passaggi e i relativi parametri
  • configura le proprietà del flusso di lavoro, tra cui fasi, se il flusso di lavoro è transitorio e/o utilizza più risorse

La modifica di un flusso di lavoro Predefinito e/o Legacy (preconfigurato) include un ulteriore passaggio per assicurarsi che venga eseguita una copia sicura prima di apportare le modifiche.

Una volta completati gli aggiornamenti al flusso di lavoro, devi usare Sync per Generare un modello di runtime. Per informazioni, consulta Sincronizzare il flusso di lavoro.

Sincronizzare il flusso di lavoro - Generare un modello di runtime

Sync (direttamente nella barra degli strumenti dell'editor) genera un modello runtime. Il modello di runtime è il modello effettivamente utilizzato quando un utente avvia un flusso di lavoro. Se non Sincronizza le modifiche, queste non saranno disponibili in fase di esecuzione.

Quando apporti modifiche al flusso di lavoro (o qualsiasi altro utente), devi utilizzare Sync per generare un modello di runtime, anche quando le singole finestre di dialogo (ad esempio, i passaggi) hanno le proprie opzioni di salvataggio.

Quando le modifiche vengono sincronizzate con il modello di runtime (salvato), viene visualizzato Synched.

Alcuni passaggi dispongono di campi obbligatori e/o di una convalida incorporata. Se queste condizioni non sono soddisfatte, viene visualizzato un errore quando si tenta di sincronizzare il modello. Ad esempio, se non è stato definito alcun partecipante per un passaggio Partecipante:

wf-21

Modifica di un flusso di lavoro predefinito o legacy per la prima volta

Quando apri un modello predefinito e/o legacy per la modifica:

  • Il browser Passaggi non è disponibile (lato sinistro).

  • Nella barra degli strumenti (lato destro) è disponibile un'azione Modifica.

  • Inizialmente il modello e le relative proprietà vengono presentati in modalità di sola lettura come:

    • I flussi di lavoro predefiniti si trovano in /libs
    • I flussi di lavoro legacy si trovano in /etc
      Se selezioni Modifica:

  • copia del flusso di lavoro in /conf

  • rendere disponibile il browser Passaggi

  • consente di apportare modifiche

NOTE
Per ulteriori informazioni, vedere Percorsi dei modelli di flusso di lavoro.

wf-22

Aggiunta di un passaggio a un modello

Aggiungi i passaggi al modello per rappresentare l’attività da eseguire: ogni passaggio esegue un’attività specifica. Una selezione di componenti step è disponibile in un’istanza AEM standard.

Quando modifichi un modello, i passaggi disponibili vengono visualizzati nei vari gruppi del browser Passaggi. Ad esempio:

wf-10

NOTE
Per informazioni sui componenti del passaggio principale installati con AEM, vedere Riferimento passaggi flusso di lavoro.

Per aggiungere passaggi al modello di flusso di lavoro:

  1. Apri un modello di flusso di lavoro esistente per la modifica. Dalla console Modello flussi di lavoro, seleziona il modello richiesto, quindi Modifica.

  2. Apri il browser Passaggi utilizzando Attiva/Disattiva pannello laterale, all'estrema sinistra della barra degli strumenti superiore. È possibile:

    • Filtro per passaggi specifici.
    • Utilizza il selettore a discesa per limitare la selezione a un gruppo specifico di passaggi.
    • Selezionare l'icona Mostra descrizione wf-stepinfo-icon per visualizzare ulteriori dettagli sul passaggio appropriato.

    wf-02

  3. Trascinate i passi appropriati nella posizione desiderata nel modello.

    Ad esempio, un Passaggio partecipante.

    Una volta aggiunto al flusso, puoi configurare il passaggio.

    wf-03

  4. Aggiungi tutti i passaggi, o altri aggiornamenti, necessari.

    In fase di esecuzione, i passi vengono eseguiti nell'ordine in cui vengono visualizzati nel modello. Dopo aver aggiunto i componenti del passo, potete trascinarli in una posizione diversa nel modello.

    È inoltre possibile copiare, tagliare, incollare, raggruppare o eliminare i passaggi esistenti, come con l'editor di pagine .

    È inoltre possibile comprimere/espandere i passaggi di suddivisione utilizzando l'opzione della barra degli strumenti: wf-collapseexpand-toolbar-icon

  5. Conferma le modifiche con Sync (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

Configurazione di un passaggio del flusso di lavoro

Puoi Configurare e personalizzare il comportamento di un passaggio del flusso di lavoro utilizzando le finestre di dialogo Proprietà passaggio.

  1. Per aprire la finestra di dialogo Proprietà passaggio per un passaggio:

    • Fai clic sul passaggio* *nel modello di flusso di lavoro e seleziona Configura dalla barra degli strumenti del componente.

    • Fare doppio clic sul passaggio.

    NOTE
    Per informazioni sui componenti del passaggio principale installati con AEM, vedere Riferimento passaggi flusso di lavoro.

  2. Configura il passaggio Proprietà come richiesto; le proprietà disponibili dipendono dal tipo di passaggio; potrebbero anche essere disponibili diverse schede. Ad esempio, il Passaggio partecipante predefinito, presente in un nuovo flusso di lavoro come Step 1:

    wf-11

  3. Conferma gli aggiornamenti selezionando.

  4. Conferma le modifiche con Sync (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

Creazione di un flusso di lavoro transitorio

Puoi creare un modello di flusso di lavoro Transitorio durante la creazione di un modello o modificandone uno esistente:

  1. Apri il modello di flusso di lavoro per modifica.

  2. Seleziona Proprietà modello flusso di lavoro nella barra degli strumenti.

  3. Nella finestra di dialogo attiva Flusso di lavoro transitorio (o disattiva se necessario):

    wf-07

  4. Conferma la modifica con Salva e chiudi; seguito da Sincronizza (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

NOTE
AEM Quando si esegue un flusso di lavoro in modalità transitoria, la cronologia del flusso di lavoro non viene memorizzata. Pertanto, Timeline non visualizza alcuna informazione relativa a tale flusso di lavoro.

Rendere disponibili i modelli di flusso di lavoro nell’interfaccia utente touch

Se un modello di flusso di lavoro è presente nell'interfaccia classica ma manca nel menu a comparsa di selezione nella barra Timeline dell'interfaccia utente touch, segui la configurazione per renderlo disponibile. Nei passaggi seguenti viene illustrato l'utilizzo del modello di flusso di lavoro denominato Richiesta di attivazione.

  1. Verifica che il modello non sia disponibile nell’interfaccia utente touch. Accedere a una risorsa utilizzando il percorso /assets.html/content/dam. Seleziona una risorsa. Apri Timeline nella barra a sinistra. Fai clic su Avvia flusso di lavoro e verifica che il modello Request for Activation non sia presente nell'elenco a comparsa.

  2. Passa a Strumenti > Generale > Assegnazione tag. Seleziona Flusso di lavoro.

  3. Selezionare Crea > Crea tag. Imposta Titolo come DAM e Nome come dam. Seleziona Invia.
    Crea tag nel modello di flusso di lavoro

  4. Passa a Strumenti > Flusso di lavoro > Modelli. Seleziona Richiesta di attivazione, quindi seleziona Modifica.

  5. Seleziona Modifica, apri il menu Informazioni pagina, quindi seleziona Apri proprietà e passa alla scheda Base (se non è già aperta).

  6. Aggiungi Workflow : DAM al campo Tag. Conferma la selezione selezionando (segno di spunta).

  7. Conferma l'aggiunta del tag con Salva e chiudi.
    Modifica proprietà pagina del modello

  8. Completa il processo con Sync. Il flusso di lavoro è ora disponibile nell’interfaccia utente touch.

Configurazione di un flusso di lavoro per il supporto di più risorse

È possibile configurare un modello di flusso di lavoro per Supporto risorse multiple durante la creazione di un modello o modificandone uno esistente:

  1. Apri il modello di flusso di lavoro per modifica.

  2. Seleziona Proprietà modello flusso di lavoro nella barra degli strumenti.

  3. Nella finestra di dialogo attiva Supporto risorse multiple (o disattiva se necessario):

    wf-08

  4. Conferma la modifica con Salva e chiudi; seguito da Sincronizza (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

Configurazione delle fasi del flusso di lavoro (che mostrano l’avanzamento del flusso di lavoro)

Le fasi del flusso di lavoro consentono di visualizzare l'avanzamento di un flusso di lavoro durante la gestione delle attività.

CAUTION
Se le fasi del flusso di lavoro sono definite in Proprietà pagina, ma non vengono utilizzate per alcun passaggio del flusso di lavoro, la barra di avanzamento non mostrerà alcun avanzamento (indipendentemente dal passaggio del flusso di lavoro corrente).

Le fasi da rendere disponibili sono definite nei modelli di flusso di lavoro; i modelli di flusso di lavoro esistenti possono essere aggiornati per includere le definizioni delle fasi. È possibile definire un numero qualsiasi di fasi per il modello di flusso di lavoro.

Per definire Stadi per il flusso di lavoro:

  1. Apri il modello di flusso di lavoro per la modifica.

  2. Seleziona Proprietà modello flusso di lavoro nella barra degli strumenti. Quindi apri la scheda Stadi.

  3. Aggiungi (e posiziona) le fasi richieste. È possibile definire un numero qualsiasi di fasi per il modello di flusso di lavoro.

    Ad esempio:

    wf-08-1

  4. Fai clic su Salva e chiudi per salvare le proprietà.

  5. Assegna una fase a ciascuno dei passaggi nel modello di flusso di lavoro. Ad esempio:

    wf-09

    È possibile assegnare una fase a più fasi. Ad esempio:

    Passaggio
    Fase
    Passaggio 1
    Creare
    Passaggio 2
    Creare
    Passaggio 3
    Rivedi
    Passaggio 4
    Approva
    Passaggio 5
    Approva
    Passaggio 6
    Completato

  6. Conferma le modifiche con Sync (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

Esportazione di un modello di flusso di lavoro in un pacchetto

Per esportare un modello di flusso di lavoro in un pacchetto:

  1. Creare un pacchetto utilizzando Gestione pacchetti:

    1. Passare a Gestione pacchetti tramite Strumenti, Distribuzione, Pacchetti.

    2. Fare clic su Crea pacchetto.

    3. Specificare il Nome pacchetto ed eventuali altri dettagli.

    4. Fai clic su OK.

  2. Fai clic su Modifica nella barra degli strumenti del nuovo pacchetto.

  3. Apri la scheda Filtri.

  4. Seleziona Aggiungi filtro e specifica il percorso del modello di flusso di lavoro progettazione:

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

    Fai clic su Fine.

  5. Seleziona Aggiungi filtro e specifica il percorso del modello di flusso di lavoro runtime:

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

    Fai clic su Fine.

  6. Aggiungi altri filtri per gli script personalizzati utilizzati dal modello.

  7. Fai clic su Salva per confermare le definizioni dei filtri.

  8. Seleziona Build dalla barra degli strumenti della definizione del pacchetto.

  9. Seleziona Scarica dalla barra degli strumenti del pacchetto.

Utilizzo dei flussi di lavoro per elaborare gli invii dei moduli

È possibile configurare un modulo da elaborare tramite il flusso di lavoro selezionato. Quando gli utenti inviano il modulo, viene creata una nuova istanza di flusso di lavoro con i dati dell’invio del modulo come payload.

Per configurare il flusso di lavoro da utilizzare con il modulo:

  1. Crea una pagina e aprila per la modifica.

  2. Aggiungi un componente Modulo alla pagina.

  3. Configura il componente Inizio modulo visualizzato nella pagina.

  4. Utilizza Avvia flusso di lavoro per selezionare il flusso di lavoro desiderato tra quelli disponibili:

    wf-12

  5. Conferma la nuova configurazione del modulo selezionando.

Verifica dei flussi di lavoro

È buona prassi quando si esegue il test di un flusso di lavoro per utilizzare diversi tipi di payload, inclusi quelli diversi da quello per cui è stato sviluppato. Ad esempio, se desideri che il flusso di lavoro gestisca Assets, testa impostando una pagina come payload e assicurati che non generi errori.

Ad esempio, prova il nuovo flusso di lavoro come segue:

  1. Avvia il modello di flusso di lavoro dalla console.

  2. Definisci il Payload e conferma.

  3. Intraprende le azioni necessarie in modo che il flusso di lavoro proceda.

  4. Monitora i file di registro durante l’esecuzione del flusso di lavoro.

È inoltre possibile configurare AEM per visualizzare DEBUG messaggi nei file di registro. Consulta Registrazione per ulteriori informazioni e al termine dello sviluppo, imposta di nuovo Livello registro su Informazioni.

Esempi

Esempio: creazione di un flusso di lavoro (semplice) per accettare o rifiutare una richiesta di pubblicazione

Per illustrare alcune delle possibilità di creazione di un flusso di lavoro, nell'esempio seguente viene creata una variante del flusso di lavoro Publish Example.

  1. Crea un modello di flusso di lavoro.

    Il nuovo flusso di lavoro conterrà:

    • Inizio flusso
    • Step 1
    • Fine flusso

  2. Elimina Step 1 (in quanto è il tipo di passaggio errato per questo esempio):

    • Fai clic sul passaggio e seleziona Elimina dalla barra degli strumenti del componente. Conferma l’azione.

  3. Dalla selezione Workflow del browser dei passaggi, trascina un Passaggio partecipante nel flusso di lavoro e posizionalo tra Inizio flusso e Fine flusso.

  4. Per aprire la finestra di dialogo delle proprietà:

    • Fai clic sul passaggio partecipante e seleziona Configura dalla barra degli strumenti del componente.
    • Fare doppio clic sul passaggio partecipante.

  5. Nella scheda Comune immettere Validate Content sia per Titolo che per Descrizione.

  6. Apri la scheda Utente/Gruppo:

    • Attiva Notifica all'utente tramite e-mail.
    • Selezionare Administrator ( admin) per il campo Utente/Gruppo.
    NOTE
    Per inviare le e-mail, è necessario configurare il servizio di posta e i dettagli dell'account utente.

  7. Conferma gli aggiornamenti selezionando.

    Tornerai alla panoramica del modello di flusso di lavoro. Il passaggio partecipante sarà stato rinominato Validate Content.

  8. Trascina un o una divisione nel flusso di lavoro e posizionalo tra Validate Content e Fine flusso.

  9. Apri Or Split per la configurazione.

  10. Configurare:

    • Comune: specifica il nome della divisione.

    • Ramo 1: selezionare Percorso predefinito.

    • Ramo 2: verificare che Route predefinita non sia selezionata.

  11. Conferma gli aggiornamenti alla Divisione OR.

  12. Trascina un Passaggio partecipante nel ramo sinistro, apri le proprietà, specifica i valori seguenti, quindi conferma le modifiche:

    • Titolo: Reject Publish Request

    • Utente/Gruppo: ad esempio, projects-administrators

    • Notifica all'utente tramite e-mail: attiva questa opzione per ricevere una notifica tramite e-mail.

  13. Trascina un Passaggio processo nel ramo destro, apri le proprietà, specifica i seguenti valori, quindi conferma le modifiche:

    • Titolo: Publish Page as Requested

    • Processo: selezionare Activate Page. Questo processo pubblica la pagina selezionata nelle istanze dell’editore.

  14. Fai clic su Sincronizza (barra degli strumenti dell'editor) per generare il modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

    Il nuovo modello di flusso di lavoro sarà simile al seguente:

    wf-13

  15. Applica questo flusso di lavoro alla pagina, in modo che quando l'utente passa a Completa il passaggio Convalida contenuto, possa scegliere se desidera Publish Page come richiesto o Rifiuta richiesta Publish.

    chlimage_1-72

Esempio: definizione di una regola per una suddivisione OR utilizzando lo script ECMA

I passaggi OR Split ti consentono di introdurre nel flusso di lavoro i percorsi di elaborazione condizionale.

Per definire una regola OR, procedere come segue:

  1. Crea due script e salvali nell’archivio, ad esempio, in:

    /apps/myapp/workflow/scripts

    NOTE
    Gli script devono avere una funzione check() che restituisce un valore booleano.

  2. Modifica il flusso di lavoro e aggiungi OR Split al modello.

  3. Modifica le proprietà del ramo 1 della divisione OR:

    • Definisci come Route predefinita impostando Valore su true.

    • Imposta il percorso dello script come Regola. Ad esempio:

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

    NOTE
    Se necessario, puoi cambiare l’ordine della filiale.

  4. Modifica le proprietà del ramo 2 della divisione OR.

    • Imposta il percorso dell'altro script come Regola. Ad esempio:

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

  5. Imposta le proprietà dei singoli passaggi in ciascun ramo. Verificare che l'utente/gruppo sia impostato.

  6. Fai clic su Sincronizza (barra degli strumenti dell'editor) per confermare le modifiche apportate al modello di runtime.

    Per informazioni, consulta Sincronizzare il flusso di lavoro.

Function Check()

NOTE
Vedere Utilizzo di ECMAScript.

Il seguente script di esempio restituisce true se il nodo è un JCR_PATH che si trova in /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;
     }
}

Esempio: richiesta di attivazione personalizzata

Puoi personalizzare qualsiasi flusso di lavoro predefinito. Per ottenere un comportamento personalizzato, puoi sovrapporre i dettagli del flusso di lavoro appropriato.

Richiesta di attivazione. Questo flusso di lavoro viene utilizzato per la pubblicazione di pagine in Sites e viene attivato automaticamente quando un autore di contenuti non dispone dei diritti di replica appropriati. Per ulteriori dettagli, vedi Personalizzazione dell'authoring delle pagine - Personalizzazione della richiesta per il flusso di lavoro di attivazione.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2