AEM 6.4 hat das Ende der erweiterten Unterstützung erreicht und diese Dokumentation wird nicht mehr aktualisiert. Weitere Informationen finden Sie in unserer technische Unterstützung. Unterstützte Versionen suchen here.
Hier wird beschrieben, wie Sie benutzerdefinierte Schritt-Komponenten für Ihre Workflows entwickeln und wie Sie programmatisch mit Workflows interagieren.
Die Erstellung eines benutzerdefinierten Workflow-Schritts umfasst die folgenden Aktivitäten:
Sie können auch mit Ihren Workflows aus Ihren Programmen und Skripten interagieren.
Eine Workflow-Schritt-Komponente definiert das Erscheinungsbild und Verhalten des Schritts beim Erstellen von Workflow-Modellen:
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.
Sie dürfen keinerlei Änderungen im Pfad /libs
vornehmen,
da der Inhalt von /libs
überschrieben wird, wenn Sie die Instanz das nächste Mal aktualisieren. (Außerdem kann der Inhalt auch durch Anwenden von Hotfixes oder Feature Packs überschrieben werden.)
Die empfohlene Methode für Konfigurations- und sonstige Änderungen sieht wie folgt aus:
/libs
unter /apps
existiert./apps
vor.Die Komponente /libs/cq/workflow/components/model/step
ist der nächste gemeinsame Vorgänger von Prozess-Schritt, Teilnehmer-Schritt und Dynamischer-Teilnehmer-Schritt, die alle die folgenden Elemente erben:
step.jsp
Das Skript step.jsp
rendert den Titel der Schritt-Komponente, wenn sie zu einem Modell hinzugefügt wird.
Ein Dialogfeld mit den folgenden Registerkarten:
Wenn die Registerkarten des Bearbeitungsdialogfelds einer Schritt-Komponente nicht mit diesem standardmäßigen Erscheinungsbild übereinstimmen, verfügt die Schritt-Komponente über definierte Skripte, Knoteneigenschaften oder Registerkarten für Dialogfelder, die diese geerbten Registerkarten überschreiben.
Die folgenden Objekte sind (abhängig vom Schritttyp) bei 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
Sie können Workflow-Metadaten verwenden, um Informationen beizubehalten, die während der Lebensdauer des Workflows benötigt werden. Eine gängige Anforderung an Workflow-Schritte besteht darin, Daten für die zukünftige Verwendung im Workflow beizubehalten oder die gespeicherten Daten abzurufen.
Es gibt drei Typen von MetaDataMap-Objekten – für Workflow
-, WorkflowData
- und WorkItem
-Objekte. Sie alle sollen demselben Zweck dienen- dem 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.
Die MetaDataMaps von Workflow
sowie von WorkflowData
werden über den gesamten Workflow hinweg gemeinsam verwendet. In diesen Fällen empfiehlt es sich, nur die MetaDataMap von WorkflowData
zu nutzen.
Workflow-Schritt-Komponenten können auf die gleiche Weise erstellt 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
Gehen Sie wie folgt vor, um Standardwerte für die Titel und Beschreibung -Felder auf Häufig Registerkarte.
Die Feldwerte werden in der Schrittinstanz angezeigt, wenn die beiden folgenden Anforderungen erfüllt sind:
Das Dialogfeld „Bearbeiten“ des Schritts speichert den Titel und die Beschreibung in den folgenden Orten: >
./jcr:title
./jcr:description
Speicherorte
Diese Anforderung gilt als erfüllt, wenn das Dialogfeld „Bearbeiten“ die Registerkarte „Gemeinsam“ verwendet, die von der Komponente /libs/cq/flow/components/step/step
implementiert wird.
Die Schritt-Komponente oder ein Vorgänger der Komponente überschreibt das Skript step.jsp
nicht, das von der Komponente /libs/cq/flow/components/step/step
implementiert wird.
Fügen Sie unter dem Knoten cq:Component
den folgenden Knoten hinzu:
cq:editConfig
cq:EditConfig
Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.
Fügen Sie unter dem Knoten cq:EditConfig
den folgenden Knoten hinzu:
cq:formParameters
nt:unstructured
Fügen Sie String
-Eigenschaften der folgenden Namen zum Knoten cq:formParameters
hinzu:
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.Siehe Beständige Daten und Zugriff. Insbesondere Informationen zum Zugriff auf den Eigenschaftswert zur Laufzeit finden Sie unter Zugreifen auf Dialogfeldeigenschaftswerte zur Laufzeit.
Die name-Eigenschaft von cq:Widget
-Elementen gibt den JCR-Knoten an, der den Wert des Widgets speichert. Wenn Widgets im Dialog der Schrittkomponenten des Workflows Werte unterhalb des Knotens ./metaData
speichern, wird der Wert zum Workflow MetaDataMap
hinzugefügt.
Beispiel: Ein Textfeld in einem Dialogfeld ist ein cq:Widget
-Knoten mit den folgenden Eigenschaften:
Name | Typ | Wert |
---|---|---|
xtype |
String |
textarea |
name |
String |
./metaData/subject |
fieldLabel |
String |
Email Subject |
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.
Wenn der Schlüssel PROCESS_ARGS
ist, steht der Wert in ECMA-Skript-Implementierungen über die Variable args
zur Verfügung. In diesem Fall lautet der Wert der name-Eigenschaft ./metaData/PROCESS_ARGS.
Jede Basis-Schritt-Komponente ermöglicht es den Entwicklern der Workflow-Modelle, die folgenden wichtigen Funktionen bei der Entwicklung zu konfigurieren:
Um die Komponente auf die Verwendung in einem bestimmten Workflow-Szenario zu fokussieren, konfigurieren Sie die Schlüsselfunktion im Design und entfernen Sie die Möglichkeit für Modellentwickler, sie zu ändern.
Fügen Sie unter dem Knoten cq:component den folgenden Knoten hinzu:
cq:editConfig
cq:EditConfig
Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.
Fügen Sie unter dem Knoten cq:EditConfig den folgenden Knoten hinzu:
cq:formParameters
nt:unstructured
Fügen Sie eine String
-Eigenschaft zum Knoten cq:formParameters
hinzu. Der Komponenten-Supertyp bestimmt den Namen der Eigenschaft:
PROCESS
PARTICIPANT
DYNAMIC_PARTICIPANT
Legen Sie den Wert der Eigenschaft fest:
PROCESS
: der Pfad zu dem ECMA-Skript oder der PID des Dienstes, das bzw. der das Schrittverhalten implementiertPARTICIPANT
: die ID des Benutzers, dem das erzeugte Arbeitselement zugewiesen wirdDYNAMIC_PARTICIPANT
: der Pfad zu dem ECMA-Skript oder der PID des Dienstes, das bzw. der den Benutzer auswählt, dem das Arbeitselement zugewiesen wirdUm die Möglichkeit für Modellentwickler zur Bearbeitung der Eigenschaftswerte zu entfernen, überschreiben Sie das Dialogfeld des Komponenten-Supertyps.
Passen Sie die Teilnehmer-Schritt-Komponente an, um Funktionen bereitzustellen, die sich in den Komponenten Formular „Teilnehmer-Schritt“ und Dialog „Teilnehmer-Schritt“ finden:
Führen Sie das folgende Verfahren auf der neuen Komponente durch (siehe Erstellen von benutzerdefinierten Workflow-Schritt-Komponenten):
Fügen Sie unter dem Knoten cq:Component
den folgenden Knoten hinzu:
cq:editConfig
cq:EditConfig
Weitere Informationen zum Knoten cq:editConfig finden Sie unter Konfigurieren des Bearbeitungsverhaltens einer Komponente.
Fügen Sie unter dem Knoten cq:EditConfig den folgenden Knoten hinzu:
cq:formParameters
nt:unstructured
Um ein Formular anzuzeigen, wenn der Benutzer das Arbeitselement öffnet, fügen Sie die folgende Eigenschaft zum Knoten cq:formParameters
hinzu:
FORM_PATH
String
Um ein angepasstes Dialogfeld anzuzeigen, wenn der Benutzer das Arbeitselement fertigstellt, fügen Sie die folgende Eigenschaft zum Knoten cq:formParameters
hinzu:
DIALOG_PATH
String
Fügen Sie unter dem Knoten cq:Component
den Knoten cq:EditConfig
hinzu. Fügen Sie darunter einen nt:unstructured
-Knoten hinzu (er muss den Namen cq:formParameters
aufweisen) und fügen Sie zu diesem Knoten die folgenden Eigenschaften hinzu:
Name: PROCESS_AUTO_ADVANCE
Typ: Boolean
Wert:
true
führt der Workflow diesen Schritt aus und wird fortgesetzt. Dies ist die standardmäßige und empfohlene Einstellung.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
Boolean
Sie können Workflow-Metadaten verwenden, um Informationen beizubehalten, die während der Lebensdauer des Workflows - und zwischen Schritten - erforderlich sind. Eine gängige Anforderung an Workflow-Schritte besteht darin, Daten für die zukünftige Verwendung beizubehalten oder die beibehaltenen Daten aus vorherigen Schritten abzurufen.
Workflow-Metadaten werden in einem MetaDataMap
-Objekt gespeichert. Die Java-API stellt die Methode Workflow.getWorkflowData
bereit, die ein WorkflowData
-Objekt zurückgibt, das das entsprechende MetaDataMap
-Objekt bereitstellt. Dieses WorkflowData
MetaDataMap
-Objekt ist für den OSGi-Dienst oder das ECMA-Skript einer Schritt-Komponente verfügbar.
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") steht für nachfolgende Schritte im Workflow zur Verfügung.
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());
}
}
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.
Die Variable metaData
, die dem Schritt-Skript unmittelbar zur Verfügung steht, enthält die Metadaten des Schritts. Die Schritt-Metadaten unterscheiden sich von den Workflow-Metadaten.
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));
}
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.
Weitere Informationen zum Konfigurieren des Komponentendialogfelds für die Speicherung von Eigenschaften als Workflow-Metadaten finden Sie unter Speichern von Eigenschaftswerten in Workflow-Metadaten.
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.
Bei ECMA-Skript-Implementierungen ist der Wert durch die Variablen args
und metadata
verfügbar.
Das Dialogfeld „Bearbeiten“ der Komponente Process Step enthält die Eigenschaft Arguments. Der Wert der Eigenschaft Argumente wird in den Workflow-Metadaten gespeichert und mit dem Schlüssel PROCESS_ARGS
verknüpft.
Im folgenden Diagramm hat die Eigenschaft Argumente den Wert argument1, argument2
:
Der folgende Java-Code ist die execute
-Methode für eine WorkflowProcess
-Implementierung. Die Methode protokolliert den Wert in der args
-MetaDataMap
, die mit dem Schlüssel PROCESS_ARGS
verknüpft ist.
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 Prozessschritt, der diese Java-Implementierung verwendet, 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
Das folgende ECMA-Skript wird als Prozess für die Prozessschritt. Es protokolliert die Anzahl der Argumente 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"));
In diesem Abschnitt wird die Verwendung von Argumenten für Prozess-Schritte beschrieben. Die Informationen gelten auch für dynamische Teilnehmer.
Ein weiteres Beispiel für das Speichern von Komponenteneigenschaften in Workflow-Metadaten finden Sie unter Beispiel: Erstellen eines Logger-Workflow-Schritts. Dieses Beispiel enthält ein Dialogfeld, das den Metadatenwert mit einem anderen Schlüssel als PROCESS_ARGS verknüpft.
In einem Skript für eine Prozess-Schritt-Komponente sind die Argumente über das Objekt args
verfügbar.
Beim Erstellen einer benutzerdefinierten Schritt-Komponente ist das Objekt metaData
in einem Skript verfügbar. Dieses Objekt ist auf ein einziges String-Argument beschränkt.
Wenn Prozessschritte während des 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, das die für Ihren Workflow erforderlichen Aktionen ausführt.
Informationen zum Verknüpfen der Prozessschritt-Komponente mit dem Dienst oder Skript finden Sie unter Prozessschritt oder Überschreiben der Schrittimplementierung.
So definieren Sie einen Prozess-Schritt als OSGi-Dienstkomponente (Java-Paket):
Erstellen Sie das Paket und stellen Sie es im OSGi-Container bereit. Informationen zum Erstellen eines Pakets mit CRXDE Lite oder Eclipse finden Sie in der Dokumentation.
Die OSGi-Komponente muss die WorkflowProcess
-Schnittstelle mit ihrer execute()
-Methode implementieren. Siehe Beispiel-Code unten.
Der Paketname muss zum Abschnitt <*Private-Package*>
der maven-bundle-plugin
-Konfiguration hinzugefügt werden.
Fügen Sie die SCR-Eigenschaft process.label
hinzu und legen Sie den Wert nach Bedarf fest. Unter diesem Namen wird der Prozess-Schritt bei der allgemeinen Prozess-Schritt-Komponente aufgeführt. Siehe Beispiel unten.
Fügen Sie im Editor für Modelle über die allgemeine Prozess-Schritt-Komponente den Prozess-Schritt zum Workflow hinzu.
Wechseln Sie im Dialogfeld „Bearbeiten“ (vom Prozess-Schritt) zur Registerkarte Prozess und wählen Sie Ihre Prozessimplementierung aus.
Wenn Sie Argumente in Ihrem Code verwenden, legen Sie die Prozessargumente fest. Beispiel: false.
Speichern Sie die Änderungen sowohl für den Schritt als auch für das Workflow-Modell (obere linke Ecke des Modell-Editors).
Die Java-Methoden bzw. die Klassen, die die ausführbare Java-Methode implementieren, werden als OSGi-Dienste registriert, 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 Payload 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");
}
}
Wenn der Prozess dreimal hintereinander fehlschlägt, wird ein Element im Posteingang des Workflow-Administrators platziert.
ECMA-Skripte ermöglichen es Skriptentwicklern, Prozessschritte zu 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 unmittelbar für Prozessskripte verfügbar sind und Zugriff auf Objekte der Workflow-Java-API bieten.
Java-Klasse | Name der Skriptvariablen | Beschreibung |
---|---|---|
com.adobe.granite.workflow.exec.WorkItem |
graniteWorkItem |
Die aktuelle Schrittinstanz. |
com.adobe.granite.workflow.WorkflowSession |
graniteWorkflowSession |
Die Workflow-Sitzung der aktuellen Schrittinstanz. |
String[] (enthält Prozessargumente) |
args |
Die Schrittargumente. |
com.adobe.granite.workflow.metadata.MetaDataMap |
metaData |
Die Metadaten der aktuellen Schrittinstanz. |
org.apache.sling.scripting.core.impl.InternalScriptHelper |
sling |
Bietet Zugriff auf die Sling-Laufzeitumgebung. |
Das folgende Beispielskript zeigt den Zugriff auf den JCR-Knoten, der die Workflow-Payload repräsentiert. Die Variable graniteWorkflowSession
ist an eine JCR-Sitzungsvariable angepasst, mit der der Knoten vom Payload-Pfad 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 es sich bei der Payload um ein Bild (.png
-Datei) handelt, erstellt ein Schwarz-Weiß-Bild davon und speichert es als gleichrangingen 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:
Erstellen Sie das Skript (z. B. mit CRXDE Lite) und speichern Sie es im Repository unter /apps/myapp/workflow/scripts
.
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. |
Bearbeiten Sie die Prozessschritt und geben Sie das zu verwendende Skript an.
Sie können Teilnehmerentscheidungen für Dynamischer Teilnehmer - Schritt Komponenten.
Wenn eine Dynamischer-Teilnehmer-Schritt-Komponente während eines Workflows gestartet wird, muss der Schritt feststellen, welchem Teilnehmer das erzeugte Arbeitselement zugewiesen werden kann. Dazu geht der Schritt auf eine der folgenden Weisen vor:
Sie können einen Dienst oder ein ECMA-Skript entwickeln, das den Teilnehmer entsprechend den Anforderungen Ihres Workflows auswählt.
Weitere Informationen zur Zuordnung Ihrer Dynamischer Teilnehmer - Schritt -Komponente mit dem Dienst oder Skript, siehe Dynamischer Teilnehmer - Schritt oder Überschreiben der Schrittimplementierung.
So definieren Sie einen Teilnehmerschritt als OSGi-Dienstkomponente (Java-Klasse):
Die OSGi-Komponente muss die ParticipantStepChooser
-Schnittstelle mit ihrer getParticipant()
-Methode implementieren. Siehe Beispiel-Code unten.
Erstellen Sie das Paket und stellen Sie es im OSGi-Container bereit.
Fügen Sie die SCR-Eigenschaft chooser.label
hinzu und legen Sie den Wert nach Bedarf fest. Unter diesem Namen wird die Teilnehmerauswahl bei Nutzung der Dynamischer-Teilnehmer-Schritt-Komponente aufgeführt. 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";
}
}
Fügen Sie im Editor für Modelle über die allgemeine Dynamischer-Teilnehmer-Schritt-Komponente den Dynamischer-Teilnehmer-Schritt zum Workflow hinzu.
Wählen Sie im Dialogfeld „Bearbeiten“ auf der Registerkarte Teilnehmer-Auswahl Ihre Auswahlimplementierung aus.
Wenn Sie Argumente in Ihrem Code verwenden, legen Sie die Prozessargumente fest. In diesem Beispiel: /content/we-retail/de
.
Speichern Sie die Änderungen sowohl für den Schritt als auch für das Workflow-Modell.
Sie können ein ECMA-Skript erstellen, das den Benutzer auswählt, dem das Arbeitselement zugewiesen ist, dem die Teilnehmer-Schritt generiert. 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.
Skripte befinden sich im JCR-Repository und werden von dort aus ausgeführt.
In der folgenden Tabelle sind die Variablen aufgeführt, die sofortigen Zugriff auf Workflow-Java-Objekte in Ihren Skripten bieten.
Java-Klasse | Name der Skriptvariablen |
---|---|
com.adobe.granite.workflow.exec.WorkItem |
graniteWorkItem |
com.adobe.granite.workflow.WorkflowSession |
graniteWorkflowSession |
String[] (enthält Prozessargumente) |
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";
}
}
}
Erstellen Sie das Skript (z. B. mit CRXDE Lite) und speichern Sie es im Repository unter /apps/myapp/workflow/scripts
.
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. |
Bearbeiten Sie die Dynamischer-Teilnehmer-Schritt-Instanz und legen Sie das zu verwendende Skript fest.
Workflow-Pakete kann zur Verarbeitung an einen Workflow übergeben werden. Workflow-Pakete enthalten Verweise auf Ressourcen wie Seiten und Assets.
Die folgenden Workflow-Prozessschritte akzeptieren Workflow-Pakete für die Massenaktivierung von Seiten:
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-Paket-KlasseResourceCollectionUtil
: Zum Abrufen von ResourceCollection-ObjektenResourceCollectionManager
: Erstellt Sammlungen und ruft sie ab. Eine Implementierung wird als OSGi-Dienst. bereitgestellt.Die folgende Java-Beispielklasse 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;
}
}
Eine einfache Möglichkeit, mit der Erstellung Ihres eigenen benutzerdefinierten Schritts zu beginnen, besteht darin, einen vorhandenen Schritt aus folgenden Quellen zu kopieren:
/libs/cq/workflow/components/model
Erstellen Sie den Pfad unter /apps neu. Beispiel:
/apps/cq/workflow/components/model
Die neuen Ordner weisen den Typ nt:folder
auf:
- apps
- cq
- workflow (nt:folder)
- components (nt:folder)
- model (nt:folder)
Dieser Schritt gilt nicht für den Modell-Editor der klassischen Benutzeroberfläche.
Platzieren Sie dann den kopierten Schritt in den Ordner /apps . Beispiel:
/apps/cq/workflow/components/model/myCustomStep
Hier sehen Sie das Ergebnis unseres Beispiels für einen angepassten Schritt:
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.
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 erbt er vom Basisschritt unter cq/workflow/components/model/step
, aber Sie können auch andere Supertypen wie participant
, process
usw. verwenden.
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
Zum Festlegen eines Coral-Symbols für den Schritt
componentGroup
Muss eine der folgenden sein:
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:
Nachher Erstellen des grundlegenden Schritts, definieren Sie den Schritt . Konfigurieren Dialogfeld wie folgt:
Konfigurieren Sie die Eigenschaften auf dem Knoten cq:editConfig
wie folgt:
Relevante Eigenschaften:
cq:inherit
Bei true
erbt die Schritt-Komponente Eigenschaften von dem Schritt, den Sie im sling:resourceSuperType
festgelegt haben.
cq:disableTargeting
Nach Bedarf festlegen
Konfigurieren Sie die Eigenschaften auf dem Knoten 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.
Konfigurieren Sie die Eigenschaften auf dem Knoten 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 ordnungsgemäße Funktionieren des Editors von wesentlicher Bedeutung. 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.
Sie können nun eine Instanz Ihres Schritts zu einem Workflow-Modell hinzufügen. Beim Konfigurieren des Schritts wird das folgende Dialogfeld angezeigt:
Das Markup für einen benutzerdefinierten Schritt findet sich in der Datei .content.xml
des Stammknotens der Komponente. Die in diesem Beispiel verwendete Datei .content.xml
:
/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 in diesem Beispiel verwendete Datei _cq_editConfig.xml
:
<?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 in diesem Beispiel verwendete Datei _cq_dialog/.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" 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>
Beachten Sie die allgemeinen Knoten und Prozessknoten in der Dialogfelddefinition. Diese werden aus dem Prozessschritt übernommen, den wir als Supertyp für unseren benutzerdefinierten Schritt verwendet haben:
sling:resourceSuperType : cq/workflow/components/model/process
Die Modell-Editor-Dialogfelder der klassischen Benutzeroberfläche funktionieren auch weiterhin mit dem standardmäßigen Editor für die Touch-optimierte Benutzeroberfläche.
AEM Modernisierungsinstrumente , wenn Sie Ihre Schrittdialogfelder für die klassische Benutzeroberfläche in Standarddialogfelder für die Benutzeroberfläche aktualisieren möchten. Nach der Umwandlung können Sie das Dialogfeld für bestimmte Fälle noch manuell verbessern.
Wenn ein upgegradetes Dialogfeld leer ist, können Sie Dialogfelder unter /libs
mit ähnlicher Funktionalität als Lösungsbeispiele heranziehen. Beispiel:
/libs/cq/workflow/components/model
/libs/cq/workflow/components/workflow
/libs/dam/components
/libs/wcm/workflow/components/autoassign
/libs/cq/projects
Im Verzeichnis /libs
dürfen Sie keine Änderungen vornehmen, sondern sollen die Elemente lediglich als Beispiele nutzen. Wenn Sie einen der vorhandenen Schritte nutzen möchten, kopieren Sie ihn in das Verzeichnis /apps
und bearbeiten Sie ihn dort.