Guida di riferimento per i passaggi dei flussi di lavoro workflow-step-reference
I modelli di flusso di lavoro sono composti da una serie di passaggi di vari tipi. A seconda del tipo, questi passaggi possono essere configurati ed estesi con parametri e script per fornire la funzionalità e il controllo necessari.
Proprietà passaggio step-properties
Ogni componente passo ha un Proprietà passaggio che consente di definire e modificare le proprietà richieste.
Proprietà del passaggio - Scheda comune step-properties-common-tab
Per la maggior parte dei componenti dei passaggi del flusso di lavoro è disponibile una combinazione delle seguenti proprietà, nella sezione Comune scheda della finestra di dialogo delle proprietà:
-
Titolo
Titolo del passaggio.
-
Descrizione
Una descrizione del passaggio.
-
Stadio flusso di lavoro
Un selettore a discesa per applicare un Stage al passaggio.
-
Timeout
Il periodo dopo il quale il passaggio verrà "interrotto".
Puoi scegliere tra: Disattivato, Immediato, 1 h, 6 h, 12 ore, 24 ore.
-
Gestore timeout
Il gestore che controllerà il flusso di lavoro quando il passaggio scade; ad esempio:
Auto Advancer
-
Avanzamento gestore
Seleziona questa opzione per avanzare automaticamente il flusso di lavoro al passaggio successivo dopo l’esecuzione. Se non è selezionato, lo script di implementazione deve gestire l’avanzamento del flusso di lavoro.
Proprietà passaggio - Scheda Utente/Gruppo step-properties-user-group-tab
Le seguenti proprietà sono disponibili per molti componenti dei passaggi del flusso di lavoro, nella Utente/gruppo scheda della finestra di dialogo delle proprietà:
-
Notifica all'utente via e-mail
- Puoi inviare una notifica ai partecipanti inviando loro un messaggio e-mail quando il flusso di lavoro raggiunge il passaggio .
- Se abilitata, viene inviata un’e-mail all’utente definito dalla proprietà . Utente/gruppo o a ciascun membro del gruppo, se è definito un gruppo.
-
Utente/Gruppo
- Una casella di selezione a discesa consente di navigare e selezionare un utente o un gruppo.
- Se assegni il passaggio a un utente specifico, solo questo utente può intervenire sul passaggio.
- Se assegni il passaggio a un intero gruppo, quando il flusso di lavoro raggiunge questo passaggio tutti gli utenti di questo gruppo avranno l’azione nel loro Casella in entrata flusso di lavoro.
- Vedi Partecipazione ai flussi di lavoro per ulteriori informazioni.
Suddivisione E and-split
La Divisione AND crea una suddivisione nel flusso di lavoro, dopodiché entrambi i rami saranno attivi. Puoi aggiungere i passaggi del flusso di lavoro a ogni ramo in base alle tue esigenze. Questo passaggio ti consente di introdurre più percorsi di elaborazione nel flusso di lavoro. Ad esempio, puoi consentire che determinati passaggi di revisione si verifichino in parallelo, risparmiando tempo.
AND Split - Configurazione and-split-configuration
-
Modifica le Divisione AND proprietà:
- Nome diviso: assegnare un nome a scopo esplicativo.
- Selezionare il numero di rami richiesti; 2, 3, 4 o 5.
-
Aggiungi i passaggi del flusso di lavoro ai rami come necessario.
Passaggio contenitore container-step
A Contenitore inizia un altro modello di flusso di lavoro che viene eseguito come flusso di lavoro secondario.
Questo Contenitore consente di riutilizzare i modelli di flusso di lavoro per implementare sequenze di passaggi comuni. Ad esempio, un modello di flusso di lavoro di traduzione può essere utilizzato in più flussi di lavoro di modifica.
Passaggio contenitore - Configurazione container-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Contenitore
- Flusso di lavoro secondario: Seleziona il flusso di lavoro da avviare.
Passaggio goto-step
La Passaggio Vai a consente di specificare il passaggio successivo nel modello di flusso di lavoro da eseguire, in base al risultato di uno script ECMAScript:
-
true
: La Passaggio Vai a viene completato e il motore del flusso di lavoro esegue il passaggio specificato. -
false
: La Passaggio Vai a complete e la logica di routing normale determina il passaggio successivo da eseguire.
La Passaggio Vai a consente di implementare strutture di routing avanzate nei modelli di flusso di lavoro. Ad esempio, per implementare un ciclo, la Passaggio Vai a può essere definito per eseguire un passaggio precedente nel flusso di lavoro, con lo script che valuta una condizione di ciclo.
Passaggio di Go - Configurazione goto-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Processo
- Passaggio a: Seleziona il passaggio da eseguire.
- Percorso script: Percorso di ECMAScript che determina l'esecuzione del Passaggio Vai a.
- Script: ECMAScript che determina se eseguire il Passaggio Vai a.
Simulazione di un ciclo for simulating-a-for-loop
Per simulare un ciclo for è necessario mantenere un conteggio del numero di iterazioni del ciclo che si sono verificate:
- In genere, il conteggio rappresenta un indice degli elementi su cui viene eseguito il processo nel flusso di lavoro.
- Il conteggio viene valutato come criterio di uscita del ciclo.
Ad esempio, per implementare un flusso di lavoro che esegue un'azione su più nodi JCR, puoi utilizzare un contatore di loop come indice per i nodi. Per mantenere il conteggio, memorizzare un integer
nella mappa dati dell’istanza del flusso di lavoro. Utilizza lo script del Passaggio Vai a per incrementare il conteggio e confrontare il conteggio con i criteri di uscita.
function check(){
var count=0;
var keyname="loopcount"
try{
if (workflowData.getMetaDataMap().containsKey(keyname)){
log.info("goto script: found loopcount key");
count= parseInt(workflowData.getMetaDataMap().get(keyname))+1;
}
workflowData.getMetaDataMap().put(keyname,count);
}catch(err) {
log.info(err.message);
return false;
}
if (parseInt(count) <7){
return true;
} else {
return false;
}
}
Suddivisione O or-split
La Divisione OR crea una suddivisione nel flusso di lavoro, dopodiché sarà attivo un solo ramo. Questo passaggio ti consente di introdurre i percorsi di elaborazione condizionale nel flusso di lavoro. Puoi aggiungere i passaggi del flusso di lavoro a ogni ramo in base alle tue esigenze.
Divisione OR - Configurazione or-split-configuration
-
Modifica le Divisione OR proprietà:
-
Comune
- Selezionare il numero di rami richiesti; 2, 3, 4 o 5.
-
Ramo : x>
- Percorso script: Percorso di un file contenente lo script.
- Script: Aggiungi lo script nella casella.
- Percorso predefinito: Il ramo predefinito viene seguito quando più rami restituiscono true. Per impostazione predefinita, è possibile specificare un solo ramo.
note note NOTE È disponibile una scheda separata per ogni ramo: - Lo script di ciascun ramo viene valutato uno alla volta.
- I rami vengono valutati da sinistra a destra.
- Viene eseguito il primo script che restituisce true.
- Se nessun ramo restituisce true, il flusso di lavoro non procede.
note caution CAUTION Specifica la Percorso script o Script. Non è possibile utilizzare entrambe le opzioni contemporaneamente. Se specifichi i valori di entrambe le proprietà, il passaggio utilizza il Percorso script. note note NOTE Vedi Definizione di una regola per una divisione OR. -
-
Aggiungi i passaggi del flusso di lavoro ai rami come necessario.
Passaggi e scelte dei partecipanti participant-steps-and-choosers
Passaggio partecipante participant-step
A Passaggio partecipante consente di assegnare la proprietà per una particolare azione. Il flusso di lavoro procederà solo quando l’utente ha riconosciuto manualmente il passaggio. Viene utilizzato quando desideri che un utente esegua un’azione sul flusso di lavoro; ad esempio, un passaggio di revisione.
Sebbene non sia direttamente correlata, l’autorizzazione utente deve essere presa in considerazione al momento dell’assegnazione di un’azione; l’utente deve avere accesso alla pagina che è il payload del flusso di lavoro.
Passaggio partecipante: configurazione participant-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
- Il flusso di lavoro viene completato (completato).
- Il flusso di lavoro viene interrotto (terminato).
Passaggio partecipante finestra di dialogo dialog-participant-step
Utilizza un Passaggio partecipante finestra di dialogo per raccogliere informazioni dall'utente a cui è assegnato l'elemento di lavoro. Questo passaggio è utile per raccogliere piccole quantità di dati utilizzate più avanti nel flusso di lavoro.
Al completamento del passaggio, la Elemento di lavoro completo contiene i campi definiti nella finestra di dialogo. I dati raccolti nei campi vengono memorizzati nei nodi del payload del flusso di lavoro. I passaggi successivi del flusso di lavoro possono quindi leggere il valore dal repository.
Per configurare il passaggio, specificare il gruppo o l’utente a cui assegnare l’elemento di lavoro e il percorso della finestra di dialogo.
Passaggio partecipante finestra di dialogo - Configurazione dialog-participant-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Finestra di dialogo
- Percorso finestra di dialogo: Il percorso del nodo di dialogo del finestra di dialogo creata.
Passaggio partecipante finestra di dialogo - Creazione di una finestra di dialogo dialog-participant-step-creating-a-dialog
Per creare una finestra di dialogo:
- Decidere dove saranno i dati risultanti memorizzato nel payload.
- Definire la finestra di dialogo; ciò include la definizione dei campi utilizzati per raccogliere (e salvare) i dati.
Passaggio partecipante finestra di dialogo: archiviazione dei dati nel payload dialog-participant-step-storing-data-in-the-payload
Puoi memorizzare i dati dei widget nel payload del flusso di lavoro o nei metadati dell’elemento di lavoro. Il formato del name
La proprietà del nodo del widget determina la posizione in cui vengono memorizzati i dati.
-
Archiviare i dati con il payload
-
Per memorizzare i dati dei widget come proprietà del payload del flusso di lavoro, utilizza il formato seguente per il valore della proprietà name del nodo del widget:
./jcr:content/nodename
-
I dati vengono memorizzati nel
nodename
proprietà del nodo payload. Se il nodo non contiene tale proprietà, viene creata la proprietà . -
Quando viene memorizzato con il payload, gli usi successivi della finestra di dialogo con lo stesso payload sovrascrivono il valore della proprietà.
-
-
Archiviare i dati con l’elemento di lavoro
-
Per memorizzare i dati dei widget come proprietà dei metadati dell'elemento di lavoro, utilizza il formato seguente per il valore della proprietà name:
nodename
-
I dati vengono memorizzati nel
nodename
proprietà dell'elemento di lavorometadata
. I dati vengono conservati se la finestra di dialogo viene successivamente utilizzata con lo stesso payload.
-
Passaggio partecipante finestra di dialogo - Definizione finestra di dialogo dialog-participant-step-dialog-definition
-
Struttura finestra di dialogo
Le finestre di dialogo per i passaggi partecipanti alla finestra di dialogo sono simili alle finestre di dialogo create per creare i componenti. Sono memorizzati in:
/apps/myapp/workflow/dialogs
Le finestre di dialogo per l’interfaccia touch standard hanno la seguente struttura di nodi:
code language-xml newComponent (cq:Component) |- cq:dialog (nt:unstructured) |- content |- layout |- items |- column |- items |- component0 |- component1 |- ...
note note NOTE Per ulteriori informazioni consulta Creazione e configurazione di una finestra di dialogo. -
Proprietà Percorso finestra di dialogo
La Passaggio partecipante finestra di dialogo ha Percorso finestra di dialogo (insieme alle proprietà di un Passaggio partecipante). Il valore del Percorso finestra di dialogo è il percorso della
dialog
nodo della finestra di dialogo.Ad esempio, la finestra di dialogo è contenuta in un componente denominato
EmailWatch
memorizzato nel nodo:/apps/myapp/workflows/dialogs
Per l’interfaccia touch viene utilizzato il seguente valore per Percorso finestra di dialogo proprietà:
/apps/myapp/workflow/dialogs/EmailWatch/cq:dialog
-
Definizione finestra di dialogo di esempio
Il seguente frammento di codice XML rappresenta una finestra di dialogo che memorizza un
String
nelwatchEmail
nodo del contenuto del payload. Il nodo titolo rappresenta la CampoTesto componente:code language-xml jcr:primaryType="nt:unstructured" jcr:title="Watcher Email Address Dialog" sling:resourceType="cq/gui/components/authoring/dialog"> <content jcr:primaryType="nt:unstructured" sling:resourceType="granite/ui/components/foundation/container"> <layout jcr:primaryType="nt:unstructured" margin="false" sling:resourceType="granite/ui/components/foundation/layouts/fixedcolumns" /> <items jcr:primaryType="nt:unstructured"> <column jcr:primaryType="nt:unstructured" sling:resourceType="granite/ui/components/foundation/container"> <items jcr:primaryType="nt:unstructured"> <title jcr:primaryType="nt:unstructured" fieldLabel="Notification Email Address" name="./jcr:content/watchEmails" sling:resourceType="granite/ui/components/foundation/form/textfield" /> </items> </column> </items> </content> </cq:dialog>
Questo esempio, nel caso dell’interfaccia touch, darà luogo a una finestra di dialogo come:
Passaggio partecipante dinamico dynamic-participant-step
La Passaggio partecipante dinamico è simile a Passaggio partecipante con la differenza che il partecipante viene selezionato automaticamente in fase di esecuzione.
Per configurare il passaggio , seleziona una Selettore partecipante che identifica il partecipante a cui assegnare l'elemento di lavoro, insieme a una finestra di dialogo.
Passaggio partecipante dinamico: configurazione dynamic-participant-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Selettore partecipanti
- Selettore partecipante: Nome della selezione dei partecipanti creata.
- Argomenti: Eventuali argomenti richiesti.
- E-mail: Se inviare una notifica e-mail all’utente.
-
Finestra di dialogo
- Percorso finestra di dialogo: Il percorso del nodo di dialogo del finestra di dialogo creata (come con la Passaggio partecipante finestra di dialogo).
Passaggio partecipante dinamico - Sviluppo del selettore del partecipante dynamic-participant-step-developing-the-participant-chooser
Si crea il selettore dei partecipanti. Pertanto, puoi utilizzare qualsiasi logica o criterio di selezione. Ad esempio, il selettore dei partecipanti può selezionare l'utente (all'interno di un gruppo) con il minor numero di elementi di lavoro. È possibile creare un numero qualsiasi di partecipanti che scelgono di utilizzare con diverse istanze del Passaggio partecipante dinamico nei modelli di flusso di lavoro.
Creare un servizio OSGi o un codice ECMAScript che seleziona un utente a cui assegnare l'elemento di lavoro.
-
ECMAscript
Gli script devono includere una funzione denominata getParticipant che restituisce un ID utente come
String
valore. Memorizza gli script personalizzati in, ad esempio/apps/myapp/workflow/scripts
o una sottocartella.Uno script di esempio è incluso in un'istanza AEM standard:
/libs/workflow/scripts/initiator-participant-chooser.ecma
note caution CAUTION You deve non modificare nulla nel /libs
percorso.Questo perché il contenuto di /libs
viene sovrascritto la prossima volta che aggiorni l’istanza (e può essere sovrascritto quando applichi un hotfix o un feature pack).Questo script seleziona l’iniziatore del flusso di lavoro come partecipante:
code language-none function getParticipant() { return workItem.getWorkflow().getInitiator(); }
note note NOTE La Selettore partecipante iniziatore flusso di lavoro estensione del componente Passaggio partecipante dinamico e utilizza questo script come implementazione del passaggio. -
Servizio OSGi
I servizi devono implementare com.day.cq.workflow.exec.ParticipantStepChooser interfaccia. L’interfaccia definisce i seguenti membri:
SERVICE_PROPERTY_LABEL
campo: Utilizzare questo campo per specificare il nome del selettore dei partecipanti. Il nome viene visualizzato in un elenco dei selettori di partecipanti disponibili nel Passaggio partecipante dinamico proprietà.getParticipant
metodo: Restituisce l'ID principale risolto dinamicamente comeString
valore.
note caution CAUTION La getParticipant
restituisce l'ID principale risolto dinamicamente. Può trattarsi di un ID gruppo o di un ID utente.Tuttavia, un ID gruppo può essere utilizzato solo per un Passaggio partecipante, quando viene restituito un elenco di partecipanti. Per Passaggio partecipante dinamico viene restituito un elenco vuoto che non può essere utilizzato per la delega. Per rendere la tua implementazione disponibile a Passaggio partecipante dinamico componenti, aggiungi la classe Java a un bundle OSGi che esporta il servizio e distribuisci il bundle sul server AEM.
note note NOTE Selettore casuale partecipante è un servizio di esempio che seleziona un utente casuale ( com.day.cq.workflow.impl.process.RandomParticipantChooser
). La Selettore casuale partecipante un esempio di componente step estende Passaggio partecipante dinamico e utilizza questo servizio come implementazione passo.
Passaggio partecipante dinamico - Esempio di servizio di selezione partecipanti dynamic-participant-step-example-participant-chooser-service
La seguente classe Java implementa il ParticipantStepChooser
interfaccia. La classe restituisce il nome del partecipante che ha avviato il flusso di lavoro. Il codice utilizza la stessa logica dello script di esempio ( initator-participant-chooser.ecma
) utilizza .
La @Property
l’annotazione imposta il valore della SERVICE_PROPERTY_LABEL
campo a Workflow Initiator Participant Chooser
.
package com.adobe.example;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.ParticipantStepChooser;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.metadata.MetaDataMap;
@Component
@Service
@Properties({
@Property(name = Constants.SERVICE_DESCRIPTION, value = "An example implementation of a dynamic participant chooser."),
@Property(name = ParticipantStepChooser.SERVICE_PROPERTY_LABEL, value = "Workflow Initiator Participant Chooser (service)") })
public class InitiatorParticipantChooser implements ParticipantStepChooser {
private Logger logger = LoggerFactory.getLogger(this.getClass());
public String getParticipant(WorkItem arg0, WorkflowSession arg1,
MetaDataMap arg2) throws WorkflowException {
String initiator = arg0.getWorkflow().getInitiator();
logger.info("Assigning Dynamic Participant Step work item to {}",initiator);
return initiator;
}
}
In Passaggio partecipante dinamico finestra di dialogo delle proprietà Selettore partecipante include l'elemento Workflow Initiator Participant Chooser (script)
, che rappresenta questo servizio.
"All’avvio del modello di flusso di lavoro, il registro indica l’ID dell’utente che ha avviato il flusso di lavoro e a cui è stato assegnato l’elemento di lavoro. In questo esempio, la admin
l'utente ha avviato il flusso di lavoro.
13.09.2015 15:48:53.037 *INFO* [10.176.129.223 [1347565733037] POST /etc/workflow/instances HTTP/1.1] com.adobe.example.InitiatorParticipantChooser Assigning Dynamic Participant Step work item to admin
Passaggio partecipante modulo form-participant-step
La Passaggio partecipante modulo presenta un modulo all’apertura dell’elemento di lavoro. Quando l’utente compila e invia il modulo, i dati del campo vengono memorizzati nei nodi del payload del flusso di lavoro.
Per configurare il passaggio, specificare il gruppo o l’utente a cui assegnare l’elemento di lavoro e il percorso del modulo.
Passaggio partecipante modulo - Configurazione form-participant-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Modulo
- Percorso modulo: Il percorso del modulo creato.
Passaggio partecipante modulo - Creazione del modulo form-participant-step-creating-the-form
Creare un modulo da utilizzare con un Passaggio partecipante modulo normale. Tuttavia, i moduli per un Passaggio partecipante a un modulo devono avere le seguenti configurazioni:
-
La Inizio del modulo il componente deve avere Tipo di azione proprietà impostata su
Edit Workflow Controlled Resource(s)
. -
La Inizio del modulo il componente deve avere un valore per
Form Identifier
proprietà. -
I componenti del modulo devono avere Nome elemento impostata sul percorso del nodo in cui sono memorizzati i dati del campo. Il percorso deve individuare un nodo nel contenuto del payload del flusso di lavoro. Il valore utilizza il formato seguente:
./jcr:content/path_to_node
-
Il modulo deve includere un Pulsanti Invia flusso di lavoro componente. Non configuri proprietà del componente.
I requisiti del flusso di lavoro determinano dove memorizzare i dati dei campi. Ad esempio, i dati dei campi possono essere utilizzati per configurare le proprietà del contenuto della pagina. Il seguente valore di un Nome elemento memorizza i dati del campo come valore del redirectTarget
proprietà jcr:content
nodo:
./jcr:content/redirectTarget
Nell’esempio seguente, i dati del campo vengono utilizzati come contenuto di un Testo nella pagina payload:
./jcr:content/par/text_3/text
"Il primo esempio può essere utilizzato per qualsiasi pagina che cq:Page
rendering dei componenti. Il secondo esempio può essere utilizzato solo quando la pagina del payload include un Testo componente con ID di text_3
.
Il modulo può trovarsi in qualsiasi punto dell’archivio, tuttavia gli utenti del flusso di lavoro devono essere autorizzati a leggere il modulo.
Selettore casuale partecipanti random-participant-chooser
La Selettore casuale partecipante step è un selettore dei partecipanti che assegna l'elemento di lavoro generato a un utente selezionato in modo casuale da un elenco.
Selettore casuale partecipanti - Configurazione random-participant-chooser-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Argomenti
- Partecipanti: Specifica l'elenco di utenti disponibili per la selezione. Per aggiungere un utente all’elenco, fai clic su Aggiungi elemento e digitare il percorso principale del nodo utente o l'ID utente. L'ordine degli utenti non influisce sulla probabilità di assegnazione di un elemento di lavoro.
Selettore partecipante iniziatore flusso di lavoro workflow-initiator-participant-chooser
La Selettore partecipante iniziatore flusso di lavoro step è un selettore dei partecipanti che assegna l'elemento di lavoro generato all'utente che ha avviato il flusso di lavoro. Non sono disponibili proprietà da configurare diverse da Comune proprietà.
Selettore partecipante iniziatore flusso di lavoro - Configurazione workflow-initiator-participant-chooser-configuration
Per configurare il passaggio , modifica utilizzando le seguenti schede:
Passaggio processo process-step
A Passaggio al processo esegue un ECMAScript o chiama un servizio OSGi per eseguire l'elaborazione automatica.
Passaggio del processo: configurazione process-step-configuration
Per configurare il passaggio , modifica e utilizza le seguenti schede:
-
Processo
-
Processo: Implementazione del processo da eseguire. Utilizzare il menu a discesa per selezionare il servizio ECMAScript o OSGi. Per informazioni su:
- I servizi standard ECMAScripts e OSGi, vedi Processi incorporati per i passaggi del processo.
- Creazione di script ECMAS per un Processo passo, vedi Implementazione di un passaggio del processo con uno script ECMAScript.
- Creazione di servizi OSGi per un Processo passo, vedi Implementazione di un passaggio del processo con una classe Java.
-
Avanzamento gestore: Seleziona questa opzione per avanzare automaticamente il flusso di lavoro al passaggio successivo dopo l’esecuzione. Se non è selezionato, lo script di implementazione deve gestire l’avanzamento del flusso di lavoro.
-
Argomenti: Argomenti da passare al processo.
-