Estensione della funzionalità del flusso di lavoro

In questo argomento viene descritto come sviluppare componenti passo personalizzati per i flussi di lavoro e come interagire in modo programmatico con i flussi di lavoro.

La creazione di un passaggio di workflow personalizzato include le attività seguenti:

• Sviluppare il componente fase del flusso di lavoro.
• Implementate la funzionalità step come servizio OSGi o script ECMA.

È inoltre possibile interagire con i flussi di lavoro da programmi e script.

Componenti della fase del flusso di lavoro - Nozioni di base

Un componente passo del flusso di lavoro definisce l’aspetto e il comportamento del passaggio durante la creazione di modelli di workflow:

• La categoria e il nome del passaggio nella barra laterale del flusso di lavoro.
• Aspetto del passaggio nei modelli di workflow.
• Finestra di dialogo di modifica per la configurazione delle proprietà del componente.
• Il servizio o lo script che viene eseguito in fase di esecuzione.

Come per tutti i componenti, i componenti dei passaggi del flusso di lavoro ereditano dal componente specificato per la proprietà sling:resourceSuperType. Il diagramma seguente mostra la gerarchia dei nodi cq:component che costituiscono la base di tutti i componenti dei passaggi del flusso di lavoro. Il diagramma include anche i componenti Passaggio processo, Passaggio partecipante e Passaggio partecipante dinamico, in quanto questi sono i punti di partenza più comuni (e di base) per lo sviluppo di componenti passo personalizzati.

Il componente /libs/cq/workflow/components/model/step è l'antenato comune più vicino di Passaggio processo, Passaggio partecipante e Passaggio partecipante dinamico, che ereditano tutti i seguenti elementi:

• step.jsp

  Lo script step.jsp esegue il rendering del titolo del componente passo quando viene aggiunto a un modello.

  

• cq:dialog

  Una finestra di dialogo con le seguenti schede:

  • Comune: per modificare il titolo e la descrizione.
  • Avanzate: per modificare le proprietà delle notifiche e-mail.

  

  NOTA

  Quando le schede della finestra di dialogo di modifica di un componente passo non corrispondono a questo aspetto predefinito, il componente passo dispone di script definiti, proprietà del nodo o schede di dialogo che ignorano queste schede ereditate.

Script ECMA

I seguenti oggetti sono disponibili (a seconda del tipo di passaggio) negli script ECMA:

• WorkItemItem

• WorkflowSessionWorkflow WorkflowSession

• WorkflowDataworkflowData

• args: con gli argomenti di processo.

• sling: per accedere ad altri servizi OSGI.

• jcrSession

MetaDataMaps

Potete utilizzare i metadati del flusso di lavoro per mantenere le informazioni necessarie per tutta la durata del flusso di lavoro. Un requisito comune dei passaggi del flusso di lavoro consiste nel mantenere i dati per un utilizzo futuro nel flusso di lavoro o nel recuperare i dati persistenti.

Esistono tre tipi di oggetti MetaDataMap: per gli oggetti Workflow, WorkflowData e WorkItem. Hanno tutti lo stesso scopo, ovvero memorizzare i metadati.

Un oggetto WorkItem ha una propria MetaDataMap che può essere utilizzata solo mentre l'elemento di lavoro (ad es. step) è in esecuzione.

Sia i metadati Workflow che WorkflowData vengono condivisi nell'intero flusso di lavoro. Per questi casi si consiglia di utilizzare solo la mappa di metadati WorkflowData.

Creazione di componenti personalizzati per i passaggi del flusso di lavoro

I componenti della fase del flusso di lavoro possono essere creati allo stesso modo di qualsiasi altro componente.

Per ereditare da uno dei componenti del passaggio di base (esistenti), aggiungere la seguente proprietà al nodo cq:Component:

• Nome: sling:resourceSuperType

• Tipo: String

• Valore: Uno dei seguenti percorsi che si risolve in un componente base:

  • cq/workflow/components/model/process
  • cq/workflow/components/model/participant
  • cq/workflow/components/model/dynamic_participant

Specifica del titolo e della descrizione predefiniti per le istanze del passaggio

Utilizzare la procedura seguente per specificare i valori predefiniti per i campi Title e Description nella scheda Common.

1. Sotto il nodo cq:Component, aggiungi il seguente nodo:

   • Nome: cq:editConfig
   • Tipo: cq:EditConfig
   NOTA

   Per ulteriori informazioni sul nodo cq:editConfig, vedere Configuring the Edit Behavior of a Component (Configurazione del comportamento di modifica di un componente).

2. Sotto il nodo cq:EditConfig, aggiungi il seguente nodo:

   • Nome: cq:formParameters
   • Tipo: nt:unstructured

3. Aggiungi le proprietà String dei seguenti nomi al nodo cq:formParameters:

   • jcr:title: Il valore riempie il ​​campo Titolo della ​​scheda Comunidad.
   • jcr:description: Il valore riempie il campo ​​Descrizione della scheda ​​Commontab.

Salvataggio dei valori delle proprietà nei metadati del flusso di lavoro

La proprietà name di cq:Widget elementi specifica il nodo JCR che memorizza il valore del widget. Quando i widget nella finestra di dialogo dei componenti del passaggio del flusso di lavoro memorizzano valori sotto il nodo ./metaData, il valore viene aggiunto al flusso di lavoro MetaDataMap.

Ad esempio, un campo di testo in una finestra di dialogo è un nodo cq:Widget con le seguenti proprietà:

Nome	Tipo	Valore
xtype	String	textarea
name	String	./metaData/subject
fieldLabel	String	Email Subject

Il valore specificato in questo campo di testo viene aggiunto all'oggetto [MetaDataMap](#metadatamaps) dell'istanza del flusso di lavoro ed è associato alla chiave subject.

Sostituzione dell'implementazione del passaggio

Ciascun componente passo di base consente agli sviluppatori di modelli di flusso di lavoro di configurare le seguenti funzionalità principali in fase di progettazione:

• Passaggio processo: Il servizio o lo script ECMA da eseguire in fase di esecuzione.
• Passaggio partecipante: ID dell’utente a cui è assegnato l’elemento di lavoro generato.
• Passaggio partecipante dinamico: Il servizio o lo script ECMA che seleziona l'ID dell'utente a cui è assegnato l'elemento di lavoro.

Per attivare il componente per l’utilizzo in uno scenario di flusso di lavoro specifico, configurate la funzione chiave nella progettazione e rimuovete la possibilità per gli sviluppatori di modelli di modificarla.

1. Sotto il nodo cq:component, aggiungi il seguente nodo:

   • Nome: cq:editConfig
   • Tipo: cq:EditConfig

   Per ulteriori informazioni sul nodo cq:editConfig, vedere Configuring the Edit Behavior of a Component (Configurazione del comportamento di modifica di un componente).

2. Sotto il nodo cq:EditConfig, aggiungi il seguente nodo:

   • Nome: cq:formParameters
   • Tipo: nt:unstructured

3. Aggiungere una proprietà String al nodo cq:formParameters. Il super type del componente determina il nome della proprietà:

   • Passaggio processo: PROCESS
   • Passaggio partecipante: PARTICIPANT
   • Passaggio partecipante dinamico: DYNAMIC_PARTICIPANT

4. Specificare il valore della proprietà:

   • PROCESS: Percorso dello script ECMA o del PID del servizio che implementa il comportamento del passaggio.
   • PARTICIPANT: ID dell’utente a cui è assegnato l’elemento di lavoro.
   • DYNAMIC_PARTICIPANT: Percorso dello script ECMA o del PID del servizio che seleziona l'utente per assegnare l'elemento di lavoro.

5. Per rimuovere la capacità degli sviluppatori di modelli di modificare i valori delle proprietà, ignorare la finestra di dialogo del super type del componente.

Aggiunta di Forms e finestre di dialogo ai passaggi partecipanti

Personalizzate il componente passo partecipante per fornire le funzioni disponibili nei componenti Passaggio partecipante modulo e Passaggio partecipante finestra di dialogo:

• Presentare un modulo all'utente quando apre l'elemento di lavoro generato.
• Presentare all'utente una finestra di dialogo personalizzata al completamento dell'elemento di lavoro generato.

Effettuare la seguente procedura sul nuovo componente (vedere Creazione di componenti personalizzati per passaggi del flusso di lavoro):

1. Sotto il nodo cq:Component, aggiungi il seguente nodo:

   • Nome: cq:editConfig
   • Tipo: cq:EditConfig

   Per ulteriori informazioni sul nodo cq:editConfig, vedere Configuring the Edit Behavior of a Component (Configurazione del comportamento di modifica di un componente).

2. Sotto il nodo cq:EditConfig, aggiungi il seguente nodo:

   • Nome: cq:formParameters
   • Tipo: nt:unstructured

3. Per presentare un modulo quando l'utente apre l'elemento di lavoro, aggiungere la seguente proprietà al nodo cq:formParameters:

   • Nome: FORM_PATH
   • Tipo: String
   • Valore: Percorso che risolve al modulo

4. Per visualizzare una finestra di dialogo personalizzata quando l'utente completa l'elemento di lavoro, aggiungere la seguente proprietà al nodo cq:formParameters

   • Nome: DIALOG_PATH
   • Tipo: String
   • Valore: Percorso che risolve la finestra di dialogo

Configurazione del comportamento runtime passaggio flusso di lavoro

Sotto il nodo cq:Component, aggiungere un nodo cq:EditConfig. Sotto che aggiunga un nodo nt:unstructured (deve essere denominato cq:formParameters) e a tale nodo aggiunga le seguenti proprietà:

• Nome: PROCESS_AUTO_ADVANCE

  • Tipo: Boolean

  • Valore:

    • se è impostato su true il flusso di lavoro eseguirà il passaggio e continuerà. Questo è predefinito e consigliato
    • quando false, il flusso di lavoro viene eseguito e arrestato; questo richiede una maggiore manutenzione, quindi true è consigliato

• Nome: DO_NOTIFY

  • Tipo: Boolean
  • Valore: indica se le notifiche e-mail devono essere inviate per i passaggi di partecipazione degli utenti (e presuppone che il server di posta elettronica sia configurato correttamente)

Persistenza e accesso ai dati

Dati persistenti per i passaggi successivi del flusso di lavoro

Potete utilizzare i metadati del flusso di lavoro per mantenere le informazioni necessarie per tutta la durata del flusso di lavoro, nonché per passare da un passaggio all’altro. Un requisito comune dei passaggi del flusso di lavoro consiste nel mantenere i dati per un utilizzo futuro o nel recuperare i dati persistenti dai passaggi precedenti.

I metadati del flusso di lavoro vengono memorizzati in un oggetto MetaDataMap. L'API Java fornisce il metodo Workflow.getWorkflowData per restituire un oggetto WorkflowData che fornisce l'oggetto MetaDataMap appropriato. Questo oggetto WorkflowData MetaDataMap è disponibile per il servizio OSGi o lo script ECMA di un componente step.

Java

Il metodo execute dell'implementazione WorkflowProcess viene passato all'oggetto WorkItem. Utilizzare questo oggetto per ottenere l'oggetto WorkflowData per l'istanza corrente del flusso di lavoro. Nell'esempio seguente viene aggiunto un elemento all'oggetto del flusso di lavoro MetaDataMap, quindi ogni elemento viene registrato. L’elemento ("mykey", "My Step Value") è disponibile per i passaggi successivi del flusso di lavoro.

public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {

    MetaDataMap wfd = item.getWorkflow().getWorkflowData().getMetaDataMap();

    wfd.put("mykey", "My Step Value");

    Set<String> keyset = wfd.keySet();
    Iterator<String> i = keyset.iterator();
    while (i.hasNext()){
     Object key = i.next();
     log.info("The workflow medata includes key {} and value {}",key.toString(),wfd.get(key).toString());
    }
}

Script ECMA

La variabile graniteWorkItem è la rappresentazione script ECMA dell'oggetto Java corrente WorkItem. Pertanto, potete utilizzare la variabile graniteWorkItem per ottenere i metadati del flusso di lavoro. Il seguente script ECMA può essere utilizzato per implementare un Passaggio processo per aggiungere un elemento all'oggetto MetaDataMap del flusso di lavoro e quindi registrare ogni elemento. Questi elementi sono quindi disponibili per i passaggi successivi del flusso di lavoro.

var currentDateInMillis = new Date().getTime();

graniteWorkItem.getWorkflowData().getMetaDataMap().put("hardcodedKey","theKey");

graniteWorkItem.getWorkflowData().getMetaDataMap().put("currentDateInMillisKey",currentDateInMillis);

var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
    var key = iterator.next();
    log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}

Accesso ai valori delle proprietà finestra di dialogo in fase di esecuzione

L'oggetto MetaDataMap delle istanze del flusso di lavoro è utile per memorizzare e recuperare i dati per tutta la durata del flusso di lavoro. Per le implementazioni dei componenti del passaggio del flusso di lavoro, la MetaDataMap è particolarmente utile per recuperare i valori delle proprietà dei componenti in fase di esecuzione.

Il flusso di lavoro MetaDataMap è disponibile per le implementazioni di processi script Java ed ECMA:

• Nelle implementazioni Java dell'interfaccia WorkflowProcess, il parametro args è l'oggetto MetaDataMap per il flusso di lavoro.

• Nelle implementazioni di script ECMA, il valore è disponibile utilizzando le variabili args e metadata.

Esempio: Recupero degli argomenti del componente Passaggio processo

La finestra di dialogo di modifica del componente Passaggio processo include la proprietà Arguments. Il valore della proprietà Arguments viene memorizzato nei metadati del flusso di lavoro ed è associato alla chiave PROCESS_ARGS.

Nel diagramma seguente, il valore della proprietà Arguments è argument1, argument2:

Java

Il seguente codice Java è il metodo execute per un'implementazione WorkflowProcess. Il metodo registra il valore in args MetaDataMap associato alla chiave PROCESS_ARGS.

public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
     if (args.containsKey("PROCESS_ARGS")){
      log.info("workflow metadata for key PROCESS_ARGS and value {}",args.get("PROCESS_ARGS","string").toString());
     }
    }

Quando viene eseguita una fase di processo che utilizza questa implementazione Java, il registro contiene la voce seguente:

16.02.2018 12:07:39.566 *INFO* [JobHandler: /var/workflow/instances/server0/2018-02-16/model_855140139900189:/content/we-retail/de] com.adobe.example.workflow.impl.process.LogArguments workflow metadata for key PROCESS_ARGS and value argument1, argument2

Script ECMA

Il seguente script ECMA è utilizzato come processo per il Passaggio processo. Vengono registrati il numero di argomenti e i valori degli argomenti:

var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
    var key = iterator.next();
    log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}
log.info("hardcodedKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("hardcodedKey"));
log.info("currentDateInMillisKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("currentDateInMillisKey"));

Script e argomenti di processo

All'interno di uno script per un componente Passaggio processo, gli argomenti sono disponibili tramite l'oggetto args.

Quando si crea un componente passo personalizzato, l'oggetto metaData è disponibile in uno script. Questo oggetto è limitato a un singolo argomento stringa.

Sviluppo di implementazioni delle fasi del processo

Quando i passaggi del processo vengono avviati durante il processo di un flusso di lavoro, i passaggi inviano una richiesta a un servizio OSGi o eseguono uno script ECMA. Sviluppare il servizio o lo script ECMA che esegue le azioni necessarie per il flusso di lavoro.

Implementazione di un passaggio di processo con una classe Java

Per definire un processo come componente di servizio OSGI (bundle Java):

1. Create il bundle e distribuitelo nel contenitore OSGI. Fare riferimento alla documentazione sulla creazione di un bundle con CRXDE Lite o Eclipse.

   NOTA

   Il componente OSGI deve implementare l'interfaccia WorkflowProcess con il suo metodo execute(). Vedere l'esempio di codice riportato di seguito.

   NOTA

   Il nome del pacchetto deve essere aggiunto alla sezione <*Private-Package*> della configurazione maven-bundle-plugin.

2. Aggiungete la proprietà SCR process.label e impostate il valore come desiderato. Questo sarà il nome che il passaggio del processo verrà elencato come quando si utilizza il componente generico Process Step. Vedere l'esempio seguente.

3. Nell'editor Models, aggiungere il passaggio del processo al flusso di lavoro utilizzando il componente generico Process Step.

4. Nella finestra di dialogo di modifica (del Passo processo), passare alla scheda Processo e selezionare l'implementazione del processo.

5. Se utilizzate gli argomenti nel codice, impostate gli argomenti di processo Argomenti di processo. Ad esempio: false.

6. Salvate le modifiche, sia per il passaggio che per il modello di workflow (angolo in alto a sinistra dell'editor modelli).

I metodi java, rispettivamente, le classi che implementano il metodo Java eseguibile sono registrate come servizi OSGI, consentendo di aggiungere metodi in qualsiasi momento durante il runtime.

Il seguente componente OSGI aggiunge la proprietà approved al nodo del contenuto della pagina quando il payload è una pagina:

package com.adobe.example.workflow.impl.process;

import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.exec.WorkflowProcess;
import com.adobe.granite.workflow.metadata.MetaDataMap;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;

import org.osgi.framework.Constants;

import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

/**
 * Sample workflow process that sets an <code>approve</code> property to the payload based on the process argument value.
 */
@Component
@Service
public class MyProcess implements WorkflowProcess {

 @Property(value = "An example workflow process implementation.")
 static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION;
 @Property(value = "Adobe")
 static final String VENDOR = Constants.SERVICE_VENDOR;
 @Property(value = "My Sample Workflow Process")
 static final String LABEL="process.label";

 private static final String TYPE_JCR_PATH = "JCR_PATH";

 public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
  WorkflowData workflowData = item.getWorkflowData();
  if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) {
   String path = workflowData.getPayload().toString() + "/jcr:content";
   try {
    Session jcrSession = session.adaptTo(Session.class);
    Node node = (Node) jcrSession.getItem(path);
    if (node != null) {
     node.setProperty("approved", readArgument(args));
     jcrSession.save();
    }
   } catch (RepositoryException e) {
    throw new WorkflowException(e.getMessage(), e);
   }
  }
 }

 private boolean readArgument(MetaDataMap args) {
  String argument = args.get("PROCESS_ARGS", "false");
  return argument.equalsIgnoreCase("true");
 }
}

Utilizzo di ECMAScript

Gli script ECMA consentono agli sviluppatori di script di implementare i passaggi del processo. Gli script si trovano nell'archivio JCR ed sono eseguiti da tale archivio.

Nella tabella seguente sono elencate le variabili immediatamente disponibili per l'elaborazione degli script, che forniscono l'accesso agli oggetti dell'API Java del flusso di lavoro.

Classe Java	Nome variabile script	Descrizione
com.adobe.granite.workflow.exec.WorkItem	graniteWorkItem	L’istanza del passaggio corrente.
com.adobe.granite.workflow.WorkflowSession	graniteWorkflowSession	La sessione del flusso di lavoro dell’istanza del passaggio corrente.
String[] (contiene argomenti di processo)	args	Gli argomenti step.
com.adobe.granite.workflow.metadata.MetaDataMap	metaData	I metadati dell'istanza del passaggio corrente.
org.apache.sling.scripting.core.impl.InternalScriptHelper	sling	Fornisce l'accesso all'ambiente di runtime Sling.

Lo script di esempio seguente illustra come accedere al nodo JCR che rappresenta il payload del flusso di lavoro. La variabile graniteWorkflowSession è adattata a una variabile di sessione JCR, utilizzata per ottenere il nodo dal percorso di payload.

var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
    var path = workflowData.getPayload().toString();
    var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
    var node = jcrsession.getNode(path);
    if (node.hasProperty("approved")){
     node.setProperty("approved", args[0] == "true" ? true : false);
     node.save();
 }
}

Lo script seguente verifica se il payload è un'immagine ( .png file), ne crea un'immagine in bianco e nero e la salva come nodo di pari livello.

var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
    var path = workflowData.getPayload().toString();
    var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
    var node = jcrsession.getRootNode().getNode(path.substring(1));
     if (node.isNodeType("nt:file") && node.getProperty("jcr:content/jcr:mimeType").getString().indexOf("image/") == 0) {
        var is = node.getProperty("jcr:content/jcr:data").getStream();
        var layer = new Packages.com.day.image.Layer(is);
        layer.grayscale();
                var parent = node.getParent();
                var gn = parent.addNode("grey" + node.getName(), "nt:file");
        var content = gn.addNode("jcr:content", "nt:resource");
                content.setProperty("jcr:mimeType","image/png");
                var cal = Packages.java.util.Calendar.getInstance();
                content.setProperty("jcr:lastModified",cal);
                var f = Packages.java.io.File.createTempFile("test",".png");
        var tout = new Packages.java.io.FileOutputStream(f);
        layer.write("image/png", 1.0, tout);
        var fis = new Packages.java.io.FileInputStream(f);
                content.setProperty("jcr:data", fis);
                parent.save();
        tout.close();
        fis.close();
        is.close();
        f.deleteOnExit();
    }
}

Per utilizzare lo script:

1. Creare lo script (ad esempio con CRXDE Lite) e salvarlo nell'archivio sotto /apps/myapp/workflow/scripts

2. Per specificare un titolo che identifichi lo script nella finestra di dialogo di modifica Passaggio processo, aggiungere le seguenti proprietà al nodo jcr:content dello script:

   Nome	Tipo	Valore
   jcr:mixinTypes	Name[]	mix:title
   jcr:title	String	Nome da visualizzare nella finestra di dialogo di modifica.

3. Modificare l'istanza Passaggio processo e specificare lo script da utilizzare.

Sviluppo dei selettori partecipanti

Potete sviluppare i selettori dei partecipanti per i componenti Passaggio partecipante dinamico.

Quando un componente Passaggio partecipante dinamico viene avviato durante un flusso di lavoro, il passaggio deve determinare il partecipante al quale l'elemento di lavoro generato può essere assegnato. A questo scopo, effettuare una delle seguenti operazioni:

• invia una richiesta a un servizio OSGi
• esegue uno script ECMA per selezionare il partecipante

Potete sviluppare un servizio o uno script ECMA che selezioni il partecipante in base ai requisiti del flusso di lavoro.

Sviluppo di un selettore partecipanti utilizzando una classe Java

Per definire un passaggio partecipante come componente di servizio OSGI (classe Java):

1. Il componente OSGI deve implementare l'interfaccia ParticipantStepChooser con il suo metodo getParticipant(). Vedere l'esempio di codice riportato di seguito.

   Create il bundle e distribuitelo nel contenitore OSGI.

2. Aggiungete la proprietà SCR chooser.label e impostate il valore come richiesto. Questo sarà il nome in cui è elencato il selettore partecipante, utilizzando il componente Passaggio partecipante dinamico. Vedere l'esempio:

   package com.adobe.example.workflow.impl.process;
   
   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.exec.WorkflowData;
   import com.adobe.granite.workflow.metadata.MetaDataMap;
   
   import org.apache.felix.scr.annotations.Component;
   import org.apache.felix.scr.annotations.Property;
   import org.apache.felix.scr.annotations.Service;
   
   import org.osgi.framework.Constants;
   
   /**
    * Sample dynamic participant step that determines the participant based on a path given as argument.
    */
   @Component
   @Service
   
   public class MyDynamicParticipant implements ParticipantStepChooser {
   
    @Property(value = "An example implementation of a dynamic participant chooser.")
    static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION;
       @Property(value = "Adobe")
       static final String VENDOR = Constants.SERVICE_VENDOR;
       @Property(value = "Dynamic Participant Chooser Process")
       static final String LABEL=ParticipantStepChooser.SERVICE_PROPERTY_LABEL;
   
       private static final String TYPE_JCR_PATH = "JCR_PATH";
   
       public String getParticipant(WorkItem workItem, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException {
           WorkflowData workflowData = workItem.getWorkflowData();
           if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) {
               String path = workflowData.getPayload().toString();
               String pathFromArgument = args.get("PROCESS_ARGS", String.class);
               if (pathFromArgument != null && path.startsWith(pathFromArgument)) {
                   return "admin";
               }
           }
           return "administrators";
       }
   }
   

3. Nell'editor Models, aggiungere il passaggio partecipante dinamico al flusso di lavoro utilizzando il componente Dynamic Participant Step generico.

4. Nella finestra di dialogo di modifica, selezionate la scheda Selezione partecipanti e selezionate l'implementazione del selettore.

5. Se utilizzate gli argomenti nel codice, impostate gli argomenti di processo Argomenti di processo. Per questo esempio: /content/we-retail/de.

6. Salvare le modifiche, sia per il passaggio che per il modello di workflow.

Sviluppo di un selettore partecipanti utilizzando uno script ECMA

È possibile creare uno script ECMA che selezioni l'utente a cui è assegnato l'elemento di lavoro generato da Participant Step. Lo script deve includere una funzione denominata getParticipant che non richiede argomenti e restituisce un String che contiene l'ID di un utente o di un gruppo.

Gli script si trovano nell'archivio JCR ed vengono eseguiti da tale archivio.

Nella tabella seguente sono elencate le variabili che forniscono l'accesso immediato agli oggetti Java del flusso di lavoro negli script.

Classe Java	Nome variabile script
com.adobe.granite.workflow.exec.WorkItem	graniteWorkItem
com.adobe.granite.workflow.WorkflowSession	graniteWorkflowSession
String[] (contiene argomenti di processo)	args
com.adobe.granite.workflow.metadata.MetaDataMap	metaData
org.apache.sling.scripting.core.impl.InternalScriptHelper	sling

function getParticipant() {
    var workflowData = graniteWorkItem.getWorkflowData();
    if (workflowData.getPayloadType() == "JCR_PATH") {
        var path = workflowData.getPayload().toString();
        if (path.indexOf("/content/we-retail/de") == 0) {
            return "admin";
        } else {
            return "administrators";
        }
    }
}

1. Creare lo script (ad esempio con CRXDE Lite) e salvarlo nell'archivio sotto /apps/myapp/workflow/scripts

2. Per specificare un titolo che identifichi lo script nella finestra di dialogo di modifica Passaggio processo, aggiungere le seguenti proprietà al nodo jcr:content dello script:

   Nome	Tipo	Valore
   jcr:mixinTypes	Name[]	mix:title
   jcr:title	String	Nome da visualizzare nella finestra di dialogo di modifica.

3. Modificate l'istanza Passaggio partecipante dinamico e specificate lo script da utilizzare.

Gestione dei pacchetti di flussi di lavoro

I pacchetti di flussi di lavoro possono essere passati a un flusso di lavoro per l'elaborazione. I pacchetti di flussi di lavoro contengono riferimenti a risorse quali pagine e risorse.

Potete sviluppare dei passaggi per ottenere le risorse del pacchetto ed elaborarle. I seguenti membri del pacchetto com.day.cq.workflow.collection forniscono l'accesso ai pacchetti del flusso di lavoro:

• ResourceCollection: Classe pacchetto flusso di lavoro.
• ResourceCollectionUtil: Utilizzare per recuperare gli oggetti ResourceCollection.
• ResourceCollectionManager: Crea e recupera le raccolte. Un'implementazione viene distribuita come servizio OSGi.

La seguente classe Java di esempio illustra come ottenere le risorse del pacchetto:

package com.adobe.example;

import java.util.ArrayList;
import java.util.List;

import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.collection.ResourceCollection;
import com.day.cq.workflow.collection.ResourceCollectionManager;
import com.day.cq.workflow.collection.ResourceCollectionUtil;
import com.day.cq.workflow.exec.WorkItem;
import com.day.cq.workflow.exec.WorkflowData;
import com.day.cq.workflow.exec.WorkflowProcess;
import com.day.cq.workflow.metadata.MetaDataMap;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.framework.Constants;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

@Component
@Service
public class LaunchBulkActivate implements WorkflowProcess {

 private static final Logger log = LoggerFactory.getLogger(LaunchBulkActivate.class);

 @Property(value="Bulk Activate for Launches")
  static final String PROCESS_NAME ="process.label";
 @Property(value="A sample workflow process step to support Launches bulk activation of pages")
 static final String SERVICE_DESCRIPTION = Constants.SERVICE_DESCRIPTION;

 @Reference
 private ResourceCollectionManager rcManager;
public void execute(WorkItem workItem, WorkflowSession workflowSession) throws Exception {
    Session session = workflowSession.getSession();
    WorkflowData data = workItem.getWorkflowData();
    String path = null;
    String type = data.getPayloadType();
    if (type.equals(TYPE_JCR_PATH) && data.getPayload() != null) {
        String payloadData = (String) data.getPayload();
        if (session.itemExists(payloadData)) {
            path = payloadData;
        }
    } else if (data.getPayload() != null && type.equals(TYPE_JCR_UUID)) {
        Node node = session.getNodeByUUID((String) data.getPayload());
        path = node.getPath();
    }

    // CUSTOMIZED CODE IF REQUIRED....

    if (path != null) {
        // check for resource collection
        ResourceCollection rcCollection = ResourceCollectionUtil.getResourceCollection((Node)session.getItem(path), rcManager);
        // get list of paths to replicate (no resource collection: size == 1
        // otherwise size >= 1
        List<String> paths = getPaths(path, rcCollection);
        for (String aPath: paths) {

            // CUSTOMIZED CODE....

        }
    } else {
        log.warn("Cannot process because path is null for this " + "workitem: " + workItem.toString());
    }
}

/**
 * helper
 */
private List<String> getPaths(String path, ResourceCollection rcCollection) {
    List<String> paths = new ArrayList<String>();
    if (rcCollection == null) {
        paths.add(path);
    } else {
        log.debug("ResourceCollection detected " + rcCollection.getPath());
        // this is a resource collection. the collection itself is not
        // replicated. only its members
        try {
            List<Node> members = rcCollection.list(new String[]{"cq:Page", "dam:Asset"});
            for (Node member: members) {
                String mPath = member.getPath();
                paths.add(mPath);
            }
        } catch(RepositoryException re) {
            log.error("Cannot build path list out of the resource collection " + rcCollection.getPath());
        }
    }
    return paths;
}
}

Esempio: Creazione di un passaggio personalizzato

Un modo semplice per iniziare a creare un passaggio personalizzato è quello di copiare un passaggio esistente da:

/libs/cq/workflow/components/model

Creazione del passaggio di base

1. Ricreare il percorso in /apps; ad esempio:

   /apps/cq/workflow/components/model

   Le nuove cartelle sono di tipo nt:folder:

   - apps
     - cq
       - workflow (nt:folder)
         - components (nt:folder)
           - model (nt:folder)
   

   NOTA

   Questo passaggio non si applica all’editor classico per modelli di interfaccia utente.

2. Quindi inserite il passaggio copiato nella cartella /apps; ad esempio:

   /apps/cq/workflow/components/model/myCustomStep

   Ecco il risultato del nostro esempio personalizzato passo:

   

   ATTENZIONE

   Poiché nell'interfaccia standard non vengono visualizzati sulla scheda solo il titolo e non i dettagli, details.jsp non è necessario come per l'editor dell'interfaccia classica.

3. Applicare le seguenti proprietà al nodo:

   /apps/cq/workflow/components/model/myCustomStep

   Proprietà di interesse:

   • sling:resourceSuperType

     Deve ereditare da un passaggio esistente.

     In questo esempio ereditiamo dal passaggio di base in cq/workflow/components/model/step, ma è possibile utilizzare altri super tipi come participant, process, ecc.

   • jcr:title

     Titolo visualizzato quando il componente è elencato nel browser dei passaggi (pannello a sinistra dell’editor del modello di workflow).

   • cq:icon

     Utilizzato per specificare un'icona Corallo per il passaggio.

   • componentGroup

     Deve essere uno dei seguenti:

     • Flusso di lavoro collaborazione
     • Flusso di lavoro DAM
     • Flusso di lavoro per moduli
     • Progetti
     • Flusso di lavoro WCM
     • Flusso di lavoro

   

4. È ora possibile aprire un modello di workflow per la modifica. Nel browser dei passaggi è possibile filtrare per vedere My Custom Step:

   

   Trascinate My Custom Step sul modello per visualizzare la scheda:

   

   Se non è stato definito alcun cq:icon per il passaggio, viene visualizzata un'icona predefinita utilizzando le prime due lettere del titolo. Esempio:

   

Definizione della finestra di dialogo Configurazione passo

Dopo la creazione del passaggio di base, definire il passaggio Configura come segue:

1. Configurate le proprietà sul nodo cq:editConfig come segue:

   Proprietà di interesse:

   • cq:inherit

     Se è impostata su true, il componente step erediterà le proprietà dal passaggio specificato in sling:resourceSuperType.

   • cq:disableTargeting

     Impostate come richiesto.
     

2. Configurate le proprietà sul nodo cq:formsParameter come segue:

   Proprietà di interesse:

   • jcr:title

     Imposta il titolo predefinito sulla scheda passo nella mappa del modello e nel campo Titolo della finestra di dialogo di configurazione Personalizzato - Proprietà passaggio.

   • È inoltre possibile definire proprietà personalizzate.

   

3. Configurare le proprietà sul nodo cq:listeners.

   Il nodo cq:listener e le relative proprietà consentono di impostare i gestori eventi che reagiscono agli eventi nell'editor modelli dell'interfaccia touch; ad esempio, trascinare un passaggio su una pagina modello o modificare le proprietà di un passaggio.

   Proprietà degli interessi:

   • afterMove: REFRESH_PAGE
   • afterdelete: CQ.workflow.flow.Step.afterDelete
   • afteredit: CQ.workflow.flow.Step.afterEdit
   • afterinsert: CQ.workflow.flow.Step.afterInsert

   Questa configurazione è essenziale per il corretto funzionamento dell'editor. Nella maggior parte dei casi questa configurazione non deve essere modificata.

   Tuttavia, l'impostazione di cq:inherit su true (sul nodo cq:editConfig, vedi sopra) consente di ereditare questa configurazione, senza dover includerla esplicitamente nella definizione del passaggio. Se non è presente alcuna ereditarietà, è necessario aggiungere il nodo con le proprietà e i valori seguenti.

   In questo esempio, l'ereditarietà è stata attivata in modo da poter rimuovere il nodo cq:listeners e il passaggio continuerà a funzionare correttamente.

   

4. Ora puoi aggiungere un'istanza del passaggio a un modello di workflow. Quando si Configura il passaggio viene visualizzata la finestra di dialogo:

   

Codice di esempio utilizzato in questo esempio

La marcatura per un passaggio personalizzato è rappresentata nella .content.xml del nodo principale del componente. Esempio .content.xml utilizzato per questo esempio:

/apps/cq/workflow/components/model/myCustomStep/.content.xml

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:icon="bell"
    jcr:primaryType="cq:Component"
    jcr:title="My Custom Step"
    sling:resourceSuperType="cq/workflow/components/model/process"
    allowedParents="[*/parsys]"
    componentGroup="Workflow"/>

L'esempio _cq_editConfig.xml utilizzato in questo esempio:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    cq:disableTargeting="{Boolean}true"
    cq:inherit="{Boolean}true"
    jcr:primaryType="cq:EditConfig">
    <cq:formParameters
        jcr:primaryType="nt:unstructured"
        jcr:title="My Custom Step Card"
        SAMPLE_PROPERY="sample value"/>
    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="CQ.workflow.flow.Step.afterDelete"
        afteredit="CQ.workflow.flow.Step.afterEdit"
        afterinsert="CQ.workflow.flow.Step.afterInsert"
        afterMove="REFRESH_PAGE"/>
</jcr:root>

L'esempio _cq_dialog/.content.xml utilizzato in questo esempio:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    jcr:primaryType="nt:unstructured"
    jcr:title="My Custom - Step Properties"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content
        jcr:primaryType="nt:unstructured"
        sling:resourceType="granite/ui/components/coral/foundation/tabs">
        <items jcr:primaryType="nt:unstructured">
            <common
                cq:hideOnEdit="true"
                jcr:primaryType="nt:unstructured"
                jcr:title="Common"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
            <process
                cq:hideOnEdit="true"
                jcr:primaryType="nt:unstructured"
                jcr:title="Process"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
            <mycommon
                jcr:primaryType="nt:unstructured"
                jcr:title="Common"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <columns
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <title
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                fieldLabel="Title"
                                name="./jcr:title"/>
                            <description
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/textarea"
                                fieldLabel="Description"
                                name="./jcr:description"/>
                        </items>
                    </columns>
                </items>
            </mycommon>
            <advanced
                jcr:primaryType="nt:unstructured"
                jcr:title="Advanced"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <columns
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <email
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
                                fieldDescription="Notify user via email."
                                fieldLabel="Email"
                                name="./metaData/PROCESS_AUTO_ADVANCE"
                                text="Notify user via email."
                                value="true"/>
                        </items>
                    </columns>
                </items>
            </advanced>
        </items>
    </content>
</jcr:root>