Erweitern der Workflow-Funktionen

In diesem Kapitel wird beschrieben, wie Sie angepasste Schritt-Komponenten für Ihre Workflows entwickeln und programmatisch mit den Workflows interagieren können.

Das Erstellen eines angepassten Workflow-Schritts umfasst die folgenden Aktivitäten:

• Entwickeln der Komponente des Workflow-Schritts
• Implementieren der Schrittfunktionalität als OSGi-Dienst oder ECMA-Skript

Sie können auch mit Ihren Workflows von Ihren Programmen und Skripten interagieren.

Workflow-Schritt-Komponenten – die Grundlagen

Eine Workflow-Schritt-Komponente definiert das Erscheinungsbild und das Verhalten des Schritts beim Erstellen von Workflow-Modellen:

• Kategorie und Schrittname im Workflow-Sidekick
• Erscheinungsbild des Schritts in Workflow-Modellen
• Dialogfeld „Bearbeiten“ für die Konfiguration der Komponenteneigenschaften
• Dienst oder Skript, der bzw. das zur Laufzeit ausgeführt wird

Wie alle Komponenten erben Workflow-Schritt-Komponenten von der Komponente, die für die Eigenschaft sling:resourceSuperType festgelegt ist. Das folgende Diagramm zeigt die Hierarchie von cq:component-Knoten, die die Grundlage aller Workflow-Schritt-Komponenten bilden. Das Diagramm enthält auch die Komponenten Prozess-Schritt, Teilnehmer-Schritt und Dynamischer-Teilnehmer-Schritt, da sie die gängigsten (und grundlegendsten) Ausgangspunkte für die Entwicklung angepasster Schritt-Komponenten darstellen.

Die /libs/cq/workflow/components/model/step -Komponente ist der nächste gemeinsame Vorgänger der Prozessschritt, Teilnehmer-Schritt und Dynamischer Teilnehmer - Schritt, die alle die folgenden Elemente übernehmen:

• step.jsp

  Die step.jsp rendert den Titel der Schritt-Komponente, wenn sie zu einem Modell hinzugefügt wird.

  

• cq:dialog

  Ein Dialogfeld mit den folgenden Registerkarten:

  • Allgemein: für die Bearbeitung von Titel und Beschreibung
  • Erweitert: für die Bearbeitung von E-Mail-Benachrichtigungseigenschaften

  

  HINWEIS

  Wenn die Registerkarten des Dialogfelds „Bearbeiten“ nicht mit diesem Standard-Erscheinungsbild übereinstimmen, werden diese geerbten Registerkarten von den definierten Skripten, Knoteneigenschaften oder Dialogfeld-Registerkarten der Schritt-Komponente überschrieben.

ECMA-Skripte

Die folgenden Objekte sind (je nach Schritttyp) in ECMA-Skripten verfügbar:

• WorkItem workItem

• WorkflowSession workflowSession

• WorkflowData workflowData

• args: Array mit den Prozessargumenten

• sling: für den Zugriff auf andere OSGi-Dienste

• jcrSession

MetaDataMaps

Sie können mit Workflow-Metadaten Daten speichern, die während des Lebenszyklus des Workflows benötigt werden. Eine häufig vorkommende Anforderung bei Workflow-Schritten besteht im Speichern von Daten für die zukünftige Verwendung im Workflow oder im Abrufen der gespeicherten Daten.

Es gibt drei Typen von MetaDataMap-Objekten: für Workflow, WorkflowData und WorkItem Objekte. Sie haben alle den gleichen Zweck - zum Speichern von Metadaten.

Ein WorkItem verfügt über seine eigene MetaDataMap, die nur verwendet werden kann, während das WorkItem (z. B. der Schritt) ausgeführt wird.

Beide Workflow und WorkflowData -Metadaten werden für den gesamten Workflow freigegeben. In diesen Fällen empfiehlt es sich, nur die MetaDataMap von WorkflowData zu nutzen.

Erstellen von angepassten Workflow-Schritt-Komponenten

Workflow-Schritt-Komponenten können auf dieselbe Weise erstellt werden wie jede andere Komponente.

Für das Erben von einer der (vorhandenen) Basis-Schritt-Komponenten fügen Sie die folgende Eigenschaft zum Knoten cq:Component hinzu:

• Name: sling:resourceSuperType

• Typ: String

• Wert: einer der folgenden Pfade, die zu einer Basiskomponente verweisen:

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

Festlegen von Standardtitel und -Beschreibung für Schrittinstanzen

Mit dem folgenden Verfahren können Sie die Standardwerte für die Felder Titel und Beschreibung auf der Registerkarte Allgemein festlegen.

1. Unter dem cq:Component -Knoten, fügen Sie den folgenden Knoten hinzu:

   • Name: cq:editConfig
   • Typ: cq:EditConfig
   HINWEIS

   Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.

2. Unter dem cq:EditConfig -Knoten, fügen Sie den folgenden Knoten hinzu:

   • Name: cq:formParameters
   • Typ: nt:unstructured

3. Hinzufügen String Eigenschaften der folgenden Namen für die cq:formParameters node:

   • jcr:title: Der Wert wird im Feld Titel auf der Registerkarte Allgemein angezeigt.
   • jcr:description: Der Wert wird im Feld Beschreibung auf der Registerkarte Allgemein angezeigt.

Speichern von Eigenschaftswerten in Workflow-Metadaten

Die name-Eigenschaft von cq:Widget-Elementen gibt den JCR-Knoten an, der den Wert des Widgets speichert. Wenn Widgets im Dialogfeld von Workflow-Schritt-Komponenten Werte unter dem ./metaData Knoten wird der Wert zum Workflow hinzugefügt. MetaDataMap.

Beispiel: Ein Textfeld in einem Dialogfeld ist ein cq:Widget-Knoten mit den folgenden Eigenschaften:

Der Wert, der in diesem Textfeld festgelegt wird, wird zum [MetaDataMap](#metadatamaps)-Objekt der Workflow-Instanz hinzugefügt und mit dem subject-Schlüssel verknüpft.

Überschreiben der Schrittimplementierung

Jede Basiskomponente ermöglicht es Entwicklern von Workflow-Modellen, die folgenden wichtigen Funktionen während des Entwurfs zu konfigurieren:

• Prozess-Schritt: der Dienst oder das ECMA-Skript, das zur Laufzeit ausgeführt werden soll
• Teilnehmer-Schritt: die ID des Benutzers, dem das erzeugte Arbeitselement zugewiesen wird
• Dynamischer-Teilnehmer-Schritt: der Dienst oder das ECMA-Skript, das die ID des Benutzers auswählt, dem das Arbeitselement zugewiesen wird

Um die Komponente auf die Verwendung in einem bestimmten Workflow-Szenario auszurichten, konfigurieren Sie die wichtige Funktion bei der Entwicklung und entfernen Sie die Möglichkeit für Modellentwickler, sie zu ändern.

1. Fügen Sie unter dem Knoten cq:component den folgenden Knoten hinzu:

   • Name: cq:editConfig
   • Typ: cq:EditConfig

   Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.

2. Fügen Sie unter dem Knoten cq:EditConfig den folgenden Knoten hinzu:

   • Name: cq:formParameters
   • Typ: nt:unstructured

3. Hinzufügen einer String -Eigenschaft auf cq:formParameters Knoten. Der Komponenten-Supertyp bestimmt den Namen der Eigenschaft:

   • Prozessschritt: PROCESS
   • Teilnehmer-Schritt: PARTICIPANT
   • Dynamischer Teilnehmer – Schritt: DYNAMIC_PARTICIPANT

4. Legen Sie den Wert der Eigenschaft fest:

   • PROCESS: der Pfad zu dem ECMA-Skript oder der PID des Dienstes, das bzw. der das Schrittverhalten implementiert
   • PARTICIPANT: die ID des Benutzers, dem das erzeugte Arbeitselement zugewiesen wird
   • DYNAMIC_PARTICIPANT: Der Pfad zum ECMA-Skript oder zur PID des Dienstes, der den Benutzer auswählt, dem das Arbeitselement zugewiesen werden soll.

5. Um die Möglichkeit für Modellentwickler zur Bearbeitung der Eigenschaftswerte zu entfernen, überschreiben Sie das Dialogfeld des Komponenten-Supertyps.

Hinzufügen von Formularen und Dialogfeldern zu Teilnehmer-Schritten

Anpassen der Teilnehmer-Schritt-Komponente, um Funktionen bereitzustellen, die im Abschnitt Teilnehmer-Schritt des Formulars und Dialogfeld "Teilnehmer - Schritt" Komponenten:

• Zeigen Sie dem Benutzer ein Formular an, wenn er das erstellte Arbeitselement öffnet.
• Zeigen Sie dem Benutzer ein angepasstes Dialogfeld an, wenn er das erstellte Arbeitselement fertigstellt.

Führen Sie das folgende Verfahren für Ihre neue Komponente durch (siehe Erstellen benutzerdefinierter Workflow-Schrittkomponenten):

1. Unter dem cq:Component -Knoten, fügen Sie den folgenden Knoten hinzu:

   • Name: cq:editConfig
   • Typ: cq:EditConfig

   Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.

2. Fügen Sie unter dem Knoten cq:EditConfig den folgenden Knoten hinzu:

   • Name: cq:formParameters
   • Typ: nt:unstructured

3. Um ein Formular anzuzeigen, wenn der Benutzer das Arbeitselement öffnet, fügen Sie die folgende Eigenschaft zum Knoten cq:formParameters hinzu:

   • Name: FORM_PATH
   • Typ: String
   • Wert: der Pfad, der zum Formular führt

4. Um ein angepasstes Dialogfeld anzuzeigen, wenn der Benutzer das Arbeitselement fertigstellt, fügen Sie die folgende Eigenschaft zum Knoten cq:formParameters hinzu:

   • Name: DIALOG_PATH
   • Typ: String
   • Wert: der Pfad, der zum Dialogfeld führt

Konfigurieren des Laufzeitverhaltens des Workflow-Schritts

Unter dem cq:Component Knoten, fügen Sie eine cq:EditConfig Knoten. Fügen Sie darunter eine nt:unstructured node (muss cq:formParameters) und fügen Sie diesem Knoten die folgenden Eigenschaften hinzu:

• Name: PROCESS_AUTO_ADVANCE

  • Typ: Boolean

  • Wert:

    • wenn auf true Der Workflow führt diesen Schritt aus und fährt fort - dies ist die Standardeinstellung und wird auch empfohlen
    • Bei false führt der Workflow den Schritt durch und wird dann angehalten. Hier ist ein zusätzlicher Eingriff erforderlich, weshalb der Wert true empfohlen wird.

• Name: DO_NOTIFY

  • Typ: Boolean
  • Wert: gibt an, ob E-Mail-Benachrichtigungen für Benutzerteilnahme-Schritte versendet werden sollen (und geht davon aus, dass der E-Mail-Server korrekt konfiguriert ist)

Aufbewahren von Daten und Zugreifen auf Daten

Aufbewahren von Daten für nachfolgende Workflow-Schritte

Sie können mit Workflow-Metadaten Daten speichern, die während des Lebenszyklus des Workflows – und zwischen einzelnen Schritten – benötigt werden. Eine häufig vorkommende Anforderung bei Workflow-Schritten besteht im Speichern von Daten für die zukünftige Verwendung oder im Abrufen der gespeicherten Daten von vorhergehenden Schritten.

Workflow-Metadaten werden in einem MetaDataMap-Objekt gespeichert. Die Java-API stellt die Workflow.getWorkflowData -Methode, um eine WorkflowData -Objekt, das die entsprechende MetaDataMap -Objekt. Diese WorkflowData MetaDataMap -Objekt ist für den OSGi-Dienst oder das ECMA-Skript einer Schritt-Komponente verfügbar.

Java

Die Ausführungsmethode der WorkflowProcess-Implementierung wird an das Objekt WorkItem weitergegeben. Mit diesem Objekt können Sie das WorkflowData-Objekt für die aktuelle Workflow-Instanz abrufen. Im folgenden Beispiel wird ein Element zum Workflow-Objekt MetaDataMap hinzugefügt und jedes Element protokolliert. Das Element ("mykey", "My Step Value") ist für nachfolgende Schritte im Workflow verfügbar.

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());
    }
}

ECMA-Skript

Die Variable graniteWorkItem ist die ECMA-Skript-Repräsentation des aktuellen Java-Objekts WorkItem. Daher können Sie mit der Variablen graniteWorkItem die Workflow-Metadaten abrufen. Mit dem folgenden ECMA-Skript können Sie einen Prozess-Schritt implementieren, um ein Element zum Workflow-Objekt MetaDataMap hinzuzufügen und dann jedes Element zu protokollieren. Diese Elemente sind dann für nachfolgende Schritte im Workflow verfügbar.

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));
}

Zugreifen auf Dialog-Eigenschaftswerte zur Laufzeit

Das Objekt MetaDataMap der Workflow-Instanzen ist nützlich, um Daten während des Workflow-Lebenszyklus zu speichern und abzurufen. Bei Implementierungen von Workflow-Schritt-Komponenten ist MetaDataMap besonders hilfreich, um Eigenschaftswerte der Komponenten zur Laufzeit abzurufen.

Der Workflow MetaDataMap ist für Java- und ECMA-Skript-Prozessimplementierungen verfügbar:

• Bei Java-Implementierungen der WorkflowProcess-Schnittstelle ist der Parameter args das MetaDataMap-Objekt für den Workflow.

• In ECMA-Skript-Implementierungen ist der Wert mit dem args und metadata Variablen.

Beispiel: Abrufen der Argumente der Prozess-Schritt-Komponente

Das Dialogfeld „Bearbeiten“ der Komponente Process Step enthält die Eigenschaft Arguments. Der Wert der Argumente -Eigenschaft wird in den Workflow-Metadaten gespeichert und ist mit der PROCESS_ARGS Schlüssel.

Im folgenden Diagramm wird der Wert der Variablen Argumente Eigenschaft ist argument1, argument2:

Java

Der folgende Java-Code ist die execute-Methode für eine WorkflowProcess-Implementierung. Die Methode protokolliert den Wert im args MetaDataMap , das mit der PROCESS_ARGS Schlüssel.

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());
     }
    }

Wenn ein Prozess-Schritt, der diese Java-Implementierung nutzt, ausgeführt wird, enthält das Protokoll den folgenden Eintrag:

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

ECMA-Skript

Das folgende ECMA-Skript wird als Prozess für den Prozess-Schritt genutzt. Es protokolliert die Anzahl an Argumenten und die Argumentwerte:

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"));

Skripte und Prozessargumente

In einem Skript für eine Prozess-Schritt-Komponente sind die Argumente über das Objekt args verfügbar.

Beim Erstellen einer benutzerdefinierten Schritt-Komponente wird das Objekt metaData ist in einem Skript verfügbar. Dieses Objekt ist auf ein einziges String-Argument beschränkt.

Entwickeln von Prozess-Schrittimplementierungen

Wenn Prozess-Schritte während eines Workflow-Prozesses gestartet werden, senden die Schritte eine Anfrage an einen OSGi-Dienst oder führen ein ECMA-Skript aus. Entwickeln Sie den Dienst oder das ECMA-Skript, der bzw. das die Aktionen ausführt, die für Ihren Workflow erforderlich sind.

Implementieren eines Prozess-Schritts mit einer Java-Klasse

So definieren Sie einen Prozess-Schritt als OSGi-Dienstkomponente (Java-Bundle):

1. Erstellen Sie das Bundle und stellen Sie es im OSGi-Container bereit. Weitere Informationen finden Sie in der Dokumentation zum Erstellen eines Bundles mit CRXDE Lite oder Eclipse.

   HINWEIS

   Die OSGi-Komponente muss die WorkflowProcess Schnittstelle mit execute() -Methode. Siehe Beispielcode unten.

   HINWEIS

   Der Paketname muss zum <*Private-Package*> Abschnitt maven-bundle-plugin Konfiguration.

2. Hinzufügen der SCR-Eigenschaft process.label und legen Sie den Wert nach Bedarf fest. Dies ist der Name, mit dem Ihr Prozessschritt bei der Verwendung des generischen Prozessschritt -Komponente. Siehe Beispiel unten.

3. Im Modelle Editor den Prozessschritt zum Workflow hinzufügen, indem Sie die generische Prozessschritt -Komponente.

4. Im Dialogfeld "Bearbeiten"(der Prozessschritt), navigieren Sie zum Prozess und wählen Sie Ihre Prozessimplementierung aus.

5. Wenn Sie Argumente in Ihrem Code verwenden, legen Sie die Prozess-Argumente. Beispiel: false.

6. Speichern Sie die Änderungen für den Schritt und das Workflow-Modell (obere linke Ecke des Modell-Editors).

Die Java-Methoden, respektive die Klassen, die ausführbare Java-Methoden implementieren, werden als OSGi-Dienste implementiert, sodass Sie Methoden jederzeit während der Laufzeit hinzufügen können.

Die folgende OSGi-Komponente fügt die Eigenschaft approved zum Seiteninhaltsknoten hinzu, wenn die Nutzlast eine Seite ist:

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");
 }
}

Verwenden von ECMA-Skripten

Mit ECMA-Skripten können Skriptentwickler Prozess-Schritte implementieren. Die Skripte befinden sich im JCR-Repository und werden von dort aus ausgeführt.

In der folgenden Tabelle sind die Variablen aufgeführt, die Prozess-Skripten unmittelbar zur Verfügung stehen und Zugriff auf Objekte der Workflow-Java-API bieten.

Das folgende Beispielskript zeigt den Zugriff auf den JCR-Knoten, der die Workflow-Nutzlast repräsentiert. Die Variable graniteWorkflowSession ist an eine JCR-Sitzungsvariable angepasst, mit der der Knoten vom Nutzlastpfad abgerufen wird.

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();
 }
}

Das folgende Skript prüft, ob die Payload ein Bild ist ( .png -Datei), erstellt daraus ein Schwarzweißbild und speichert es als gleichrangigen Knoten.

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();
    }
}

So verwenden Sie das Skript:

1. Erstellen Sie das Skript (z. B. mit CRXDE Lite) und speichern Sie es im Repository unten /apps/myapp/workflow/scripts

2. Um einen Titel festzulegen, der das Skript im Dialogfeld „Bearbeiten“ von Prozess-Schritt identifiziert, fügen Sie die folgenden Eigenschaften zum Knoten jcr:content Ihres Skripts hinzu:

   Name	Typ	Wert
   jcr:mixinTypes	Name[]	mix:title
   jcr:title	String	Der Name, der im Dialogfeld "Bearbeiten"angezeigt werden soll.

3. Bearbeiten Sie die Prozess-Schritt-Instanz und legen Sie das zu verwendende Skript fest.

Entwickeln von Teilnehmer-Auswahlen

Sie können Teilnehmer-Auswahlen für Dynamischer-Teilnehmer-Schritt-Komponenten entwickeln.

Wenn eine Dynamischer Teilnehmer - Schritt -Komponente während eines Workflows gestartet wird, muss der Schritt bestimmen, welchem Teilnehmer das generierte Arbeitselement zugewiesen werden kann. Dazu geht der Schritt auf eine der folgenden Weisen vor:

• sendet eine Anfrage an einen OSGi-Dienst
• Er führt ein ECMA-Skript zur Auswahl des Teilnehmers aus.

Sie können einen Dienst oder ein ECMA-Skript entwickeln, der bzw. das den Teilnehmer basierend auf den Anforderungen des Workflows auswählt.

Entwickeln einer Teilnehmer-Auswahl mit einer Java-Klasse

So definieren Sie einen Teilnehmer-Schritt als OSGi-Dienstkomponente (Java-Bundle):

1. Die OSGi-Komponente muss die ParticipantStepChooser Schnittstelle mit getParticipant() -Methode. Siehe Beispielcode unten.

   Erstellen Sie das Bundle und stellen Sie es im OSGi-Container bereit.

2. Hinzufügen der SCR-Eigenschaft chooser.label und legen Sie den Wert nach Bedarf fest. Dies ist der Name, unter dem Ihre Teilnehmerauswahl aufgeführt wird, wobei die Variable Dynamischer Teilnehmer - Schritt -Komponente. Siehe folgendes Beispiel:

   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. Im Modelle Bearbeiten Sie den Schritt "Dynamischer Teilnehmer"mit dem generischen Dynamischer Teilnehmer - Schritt -Komponente.

4. Wählen Sie im Dialogfeld "Bearbeiten"die Teilnehmerauswahl und wählen Sie die gewünschte Implementierung aus.

5. Wenn Sie Argumente in Ihrem Code verwenden, legen Sie die Prozess-Argumente. Beispiel: /content/we-retail/de.

6. Speichern Sie die Änderungen für den Schritt und das Workflow-Modell.

Entwickeln einer Teilnehmer-Auswahl mit einem ECMA-Skript

Sie können ein ECMA-Skript erstellen, das den Benutzer auswählt, dem das vom Teilnehmer-Schritt erzeugte Arbeitselement zugewiesen wird. Das Skript muss eine Funktion namens getParticipant enthalten, das keine Argumente benötigt und einen String zurückgibt, der die ID eines Benutzers oder einer Gruppe enthält.

Die Skripte befinden sich im JCR-Repository und werden von dort aus ausgeführt.

In der folgenden Tabelle sind die Variablen aufgeführt, die unmittelbaren Zugriff auf Workflow-Java-Objekte in Ihren Skripten bereitstellen.

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. Erstellen Sie das Skript (z. B. mit CRXDE Lite) und speichern Sie es im Repository unten /apps/myapp/workflow/scripts

2. Um einen Titel festzulegen, der das Skript im Dialogfeld „Bearbeiten“ von Prozess-Schritt identifiziert, fügen Sie die folgenden Eigenschaften zum Knoten jcr:content Ihres Skripts hinzu:

   Name	Typ	Wert
   jcr:mixinTypes	Name[]	mix:title
   jcr:title	String	Der Name, der im Dialogfeld "Bearbeiten"angezeigt werden soll.

3. Bearbeiten Sie die Dynamischer Teilnehmer - Schritt und geben Sie das zu verwendende Skript an.

Verarbeiten von Workflow-Paketen

Workflow-Pakete können zur Verarbeitung an einen Workflow weitergegeben werden. Workflow-Pakete enthalten Verweise auf Ressourcen wie Seiten und Assets.

Sie können Workflow-Schritte entwickeln, die die Paketressourcen abrufen und verarbeiten. Die folgenden Elemente des Pakets com.day.cq.workflow.collection bieten Zugriff auf Workflow-Pakete:

• ResourceCollection: Workflow-Paketklasse.
• ResourceCollectionUtil: Zum Abrufen von ResourceCollection-Objekten
• ResourceCollectionManager: Erstellt und ruft Sammlungen ab. Eine Implementierung wird als OSGi-Dienst. bereitgestellt.

Die folgende Beispiel-Java-Klasse zeigt, wie Paketressourcen abgerufen werden:

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;
}
}

Beispiel: Erstellen eines angepassten Schritts

Eine einfache Möglichkeit, einen eigenen angepassten Schritt zu erstellen, besteht darin, einen vorhandenen Schritt aus folgendem Verzeichnis zu kopieren:

/libs/cq/workflow/components/model

Erstellen des Basisschritts

1. Erstellen Sie den Pfad unter /apps erneut, z. B.:

   /apps/cq/workflow/components/model

   Die neuen Ordner sind vom Typ nt:folder:

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

   HINWEIS

   Dieser Schritt gilt nicht für den Modell-Editor in der klassischen Benutzeroberfläche

2. Fügen Sie dann den kopierten Schritt in den Ordner /apps ein, z. B. als:

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

   Hier sehen Sie das Ergebnis unseres Beispiels für einen angepassten Schritt:

   

   VORSICHT

   Da in der Standard-Benutzeroberfläche nur der Titel auf der Karte angezeigt wird, die Details dagegen nicht, wird die Datei details.jsp anders als beim Editor der klassischen Benutzeroberfläche nicht benötigt.

3. Fügen Sie dem Knoten die folgenden Eigenschaften hinzu:

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

   Relevante Eigenschaften:

   • sling:resourceSuperType

     Muss von einem vorhandenen Schritt erben.

     In diesem Beispiel erben wir vom Basisschritt bei cq/workflow/components/model/step, aber Sie können andere Supertypen wie participant, process, usw.

   • jcr:title

     Das ist der Titel, der angezeigt wird, wenn die Komponente im Schritt-Browser aufgeführt wird (linkes Feld im Workflow-Modell-Editor).

   • cq:icon

     Wird zum Angeben einer Coral-Symbol für den Schritt.

   • componentGroup

     Muss einer der folgenden sein:

     • Kollaboration-Workflow
     • DAM-Workflow
     • Formular-Workflow
     • Projekte
     • WCM-Workflow
     • Workflow

   

4. Sie können jetzt ein Workflow-Modell zur Bearbeitung öffnen. Im Schritt-Browser können Sie einen Filter nutzen, um Mein angepasster Schritt anzuzeigen:

   

   Wenn Sie Mein angepasster Schritt auf das Modell ziehen, wird die Karte angezeigt:

   

   Wenn kein cq:icon für den Schritt definiert wurde, wird ein Standardsymbol mit den ersten zwei Buchstaben des Titels angezeigt. Beispiel:

   

Definieren des Schritt-Dialogfelds „Konfigurieren“

Nach dem Erstellen des Basisschritts definieren Sie den Schritt Konfigurieren wie folgt:

1. Eigenschaften des Knotens konfigurieren cq:editConfig wie folgt:

   Relevante Eigenschaften:

   • cq:inherit

     Wenn auf true, erbt Ihre Schritt-Komponente Eigenschaften von dem Schritt, den Sie in sling:resourceSuperType.

   • cq:disableTargeting

     Legen Sie die gewünschte Einstellung fest.
     

2. Eigenschaften des Knotens konfigurieren cq:formsParameter wie folgt:

   Relevante Eigenschaften:

   • jcr:title

     Legt den Standardtitel auf der Schritt-Karte in der Modellzuordnung und im Feld Titel des Konfigurationsdialogfelds Mein angepasster Schritt – Eigenschaften fest.

   • Sie können auch Ihre eigenen angepassten Eigenschaften definieren.

   

3. Eigenschaften des Knotens konfigurieren cq:listeners.

   Mit dem Knoten cq:listener und seinen Eigenschaften können Sie Ereignis-Handler festlegen, die auf Ereignisse im Modell-Editor der Touch-optimierten Benutzeroberfläche reagieren, z. B. wenn ein Schritt auf eine Modellseite gezogen wird oder Schritteigenschaften bearbeitet werden.

   Relevante Eigenschaften:

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

   Diese Konfiguration ist für das einwandfreie Funktionieren des Editors unabdingbar. In den meisten Fällen darf diese Konfiguration nicht geändert werden.

   Wenn Sie jedoch cq:inherit auf „true“ festlegen (auf dem Knoten cq:editConfig, s. o.), können Sie diese Konfiguration erben, ohne sie explizit in die Schrittdefinition einschließen zu müssen. Wenn keine Vererbung vorliegt, müssen Sie diesen Knoten mit den folgenden Eigenschaften und Werten hinzufügen.

   In diesem Beispiel wurde die Vererbung aktiviert, sodass wir den Knoten cq:listeners entfernen könnten und der Schritt trotzdem funktionieren würde.

   

4. Sie können nun eine Instanz Ihres Schritts zu einem Workflow-Modell hinzufügen. Beim Konfigurieren des Schritts wird das folgende Dialogfeld angezeigt:

   

In diesem Beispiel verwendetes Beispiel-Markup

Markup für einen benutzerdefinierten Schritt wird im .content.xml des Stammknotens der Komponente. Beispiel .content.xml verwendet für dieses Beispiel:

/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"/>

Die _cq_editConfig.xml Beispiel, das in diesem Beispiel verwendet wird:

<?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>

Die _cq_dialog/.content.xml Beispiel, das in diesem Beispiel verwendet wird:

<?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>