Prozessvariablen sind Daten, die Informationen zu einer Prozessinstanz enthalten. Folgende Prozessvariablen sind in jeder Prozessinstanz vorhanden:

Verwenden weiterer Prozessvariablen

Diese Variablen können Sie für spezielle Zwecke verwenden:

Definieren Sie in der Prozessdefinition Variablen, die innerhalb eines Prozesses genutzt werden. Definierte Variablen können an den entsprechenden Schnittstellen der Anwendung automatisch validiert und ggf. konvertiert werden.

Innerhalb eines Prozesses können Sie folgende Variablen definieren:

Eine Variablendefinition beinhaltet folgende Informationen:

Für den Datentypen Number gelten diese Einschränkungen:

Die nicht-primitiven Datentypen verwenden die folgende Notation:

Variablen werden als BPMN-Erweiterung in Form von Camunda-Properties definiert. Allgemeine Prozess- und Servicevariablen definieren Sie innerhalb des BPMN-Modells direkt im Prozessknoten. Lokale Prozessvariablen definieren Sie im Knoten der Aktivität, in der sie gültig sein sollen.

Allgemeine Prozess- und Servicevariablen 

 <process id="myProcess" name="Process with variable declaration" isExecutable="true">
    <extensionElements>
        <camunda:properties>
            <camunda:property name="variable:myVariable" value="[String]!" /> <!-- Name: "myVariable", Type: "String", Multiple: true, Mandatory: true, Startvariable: false -->
            <camunda:property name="variable:myStartVariable*" value="String" /> <!-- Name: "myStartVariable", Type: "String", Multiple: false, Mandatory: false, Startvariable: true-->
            <camunda:property name="variable:someUserTaskOutput" value="String" /> <!-- Name: "someUserTaskOutput", Type: "String", Multiple: false, Mandatory: false, Startvariable: false -->
            <camunda:property name="service:/myservice:in:input" value="String!" /> <!-- Name: "input", Type: "String", Multiple: false, Mandatory: true -->
            <camunda:property name="service:/myservice:out:output" value="Number!" /> <!-- Name: "output", Type: "Number", Multiple: false, Mandatory: true -->
        </camunda:properties>
    </extensionElements>
</userTask>

Lokale Prozessvariable 

<userTask id="userTask" name="User Task">
    <extensionElements>
        <camunda:inputOutput>
            <camunda:inputParameter name="someInput">user task input which is only available within this user task scope</camunda:inputParameter>
            <camunda:outputParameter name="someUserTaskOutput">user task output which will be written to process scope</camunda:outputParameter>
        </camunda:inputOutput>
        <camunda:properties>
            <camunda:property name="variable:someInput" value="String" />
        </camunda:properties>
    </extensionElements>
</userTask>

Beim Modellieren eigener Prozesse können Sie Prozessvariablen verwenden, um dynamische Prozesse zu erstellen. Zum Einstieg in das Arbeiten mit Prozessvariablen ist es hilfreich, wenn Sie zunächst einen einfachen Prozess mit einer Benutzeraktivität erstellen. Dieser Prozess sieht beispielsweise so aus:

Das BPMN-Modell dieses beispielhaften Prozesses ist folgendermaßen aufgebaut. Zur Vereinfachung sind die grafischen Informationen zum BPMN-Diagramm in dieser BPMN-Beispieldatei nicht enthalten.

<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:camunda="http://camunda.org/schema/1.0/bpmn" targetNamespace="" exporter="d.velop process modeler">
  <process id="GettingStarted" name="Beispiel: Einstieg" isExecutable="true">
    <startEvent id="start"/>
    <userTask id='task_hello_world' name='Hello World' camunda:candidateUsers="${variables.get('dv_initiator')}" />
    <sequenceFlow id="s1" sourceRef="start" targetRef="task_hello_world" />
        <sequenceFlow id="s2" sourceRef="task_hello_world" targetRef="end" />
    <endEvent id="end"/>        
  </process>  
</definitions>

Dieser Prozessdefinition fügen Sie nun eine neue Variablendefinition hinzu.

Hinzufügen einer Variablendefinition 

Um eine Prozessvariable verwenden zu können, müssen Sie diese der Prozessdefinition hinzufügen. In der Prozessdefinition fügen Sie die BPMN-Elemente extensionElements und camunda:properties zum BPMN-Element process hinzu. Zum Definieren der Prozessvariable fügen Sie dem BPMN-Element camunda:properties noch das Element camunda:property hinzu.

Dieses Beispiel zeigt, wie Sie die Variable message vom Datentyp String hinzufügen:

<process id="GettingStarted" name="Beispiel: Einstieg" isExecutable="true">
        <extensionElements>
      <camunda:properties>
        <camunda:property name="variable:message" value="String" />
      </camunda:properties>
    </extensionElements>
        ...
</process>

Erläuterung der Eigenschaften 

Verwenden der Prozessvariable 

Sie können die Variable message nun für den Namen der Benutzeraktivität verwenden, damit dieser Name dem Anwender in der Aufgabenliste angezeigt wird. Hierzu ersetzen Sie den vorhandenen Text in der Eigenschaft name der Benutzeraktivität durch die Methode für den Zugriff auf die Variable message:

<process id="GettingStarted" name="Beispiel: Einstieg" isExecutable="true">
        ...
        <userTask id="task_hello_world" name="${variables.get('message')}" camunda:candidateUsers="${variables.get('dv_initiator')}" />
        ...

Sie können den Wert der Variablen nun zum Beispiel beim Start des Prozesses belegen.

Weitere Informationen zur Definition von Prozessvariablen finden Sie im Kapitel Definieren von Prozessvariablen.

Mit dem Objekt variables können Sie auf die Prozessvariablen zugreifen. Der Aufruf erfolgt jeweils in der Notation variables.<methodName>( <Parameter>).

Sie können die Methoden nicht auf Prozessvariablen vom Typ File anwenden.

get( String variableName) 

Die Methode ermittelt den Wert für die Variable mit dem eingegebenen Variablennamen. Bei Variablen mit einem Mehrfachwert werden die Werte in einer Liste (collection) zurückgegeben.

getDisplayValue( String variableName) 

Die Methode ermittelt den Wert für die Variable mit dem eingegebenen Variablennamen. Je nach Datentyp findet hierbei automatisch eine entsprechende Konvertierung statt.

Bei Variablen mit einem Mehrfachwert werden die konvertierten Werte in einem String mit Kommas getrennt zurückgegeben. Sind die Variablen vom Datentyp Number, werden die konvertierten Werte in einem String mit Semikolons getrennt zurückgegeben.

getObjectValue( String variableName, String objectPath) 

Diese Methode kann nur für Variablen vom Typ Object verwendet werden. Sie ermöglicht es, auf einzelne Teile des Objekts zuzugreifen.

Beispiel:

Angenommen, es gibt eine Variable vom Typ Object mit dem Namen "myObjectVariable" und folgendem Wert:

{
  "my" : {
    "object" : {
      "path" : 123
    }
  }
}

Dann können mit der Methode getObjectValue z. B. die folgenden Teile des Objekts ermittelt werden:

Mit dem Objekt collections können Sie aus Einzelwerten eine Liste (collection) erzeugen, z.B. um einer Variablen einen Mehrfachwert zuzuweisen. Das Erzeugen einer Liste aus Einzelwerten ist beispielsweise hilfreich, wenn Sie in einer Benutzeraktivität mehrere Empfänger als Konstante hinterlegen wollen.

Beispiel

${collections.from( "identity:///identityprovider/scim/users/user1", "identity:///identityprovider/scim/users/user")}

from( Object...objects)

Die Methode erzeugt eine Liste (collection) mit den übergebenen Einzelwerten.

Prozessvariablen haben innerhalb einer Prozessinstanz immer einen bestimmten Geltungsbereich. Je nach Geltungsbereich sind lesende und schreibende Zugriffe möglich.

In jeder Prozessinstanz gibt es einen universellen Geltungsbereich, der den gesamten Prozess umfasst. Alle weiteren Geltungsbereiche, wie zum Beispiel Benutzer- oder Serviceaktivitäten, können lesend auf die Variablen im universellen Geltungsbereich zugreifen.

Zusätzliche Geltungsbereiche werden an folgenden Stellen erzeugt:

Lesende Zugriffe 

Lesende Zugriffe auf Prozessvariablen (z.B. die Verwendung in einem Ausdruck) sind unabhängig vom Geltungsbereich möglich. Wird im aktuellen Geltungsbereich kein Wert gefunden, so wird der darüber liegende Bereich durchsucht, bis ein Wert gefunden wurde.

Schreibende Zugriffe 

Wenn Sie Werte ändern möchten (z.B. in einer Benutzeraktivität mit Output-Mapping), so wird der Wert immer zunächst in den aktuellen Geltungsbereich der Aktivität übernommen. Andere Geltungsbereiche, z.B. entlang anderer Zweige im Prozess, werden dadurch bis zum Ende dieses Geltungsbereiches nicht beeinflusst. Erst am Ende des aktuellen Wertebereichs werden die Änderungen auch in alle anderen Geltungsbereiche übernommen.

Beginn von Geltungsbereichen nach Verzweigungen mit parallelen Pfaden 

Wenn ein Prozesspfad durch eine Verzweigung mit mehreren aktiven Ausgängen geteilt wird (parallele oder inklusive Verzweigung), erhält jeder ausgehende Pfad einen eigenen Geltungsbereich. Standardmäßig übernimmt nur der erste Ausgang die lokalen Variablen aus dem Geltungsbereich des eingehenden Pfads. Dieses Verhalten kann je nach Komplexität der Parallelität des Prozesses zu unerwarteten lokalen Variablen in den entsprechenden Geltungsbereichen führen. Aufgrund der Abwärtskompatibilität muss dieses Verhalten jedoch von d.velop process standardmäßig fortgeführt werden.

Damit bei den entsprechenden Verzweigungen alle aktiven Ausgänge immer auch die lokalen Variablen aus dem Geltungsbereich des eingehenden Pfades enthalten, können Sie die Einstellungen direkt für die Verzweigung festlegen. Fügen Sie der Verzweigung ein Element vom Typ camunda:property mit dem Namen gateway:keepLocalVariables und dem Wert true hinzu.

...
<bpmn:parallelGateway id="myGateway">
  <bpmn:extensionElements>
    <camunda:properties>
      <camunda:property name="gateway:keepLocalVariables" value="true" />
    </camunda:properties>
  </bpmn:extensionElements>
  <bpmn:incoming>...</bpmn:incoming>
  <bpmn:outgoing>...</bpmn:outgoing>
  <bpmn:outgoing>...</bpmn:outgoing>
  ...
</bpmn:parallelGateway>
...

Ende von Geltungsbereichen 

Am Ende eines Geltungsbereichs (z.B. bei der Zusammenführung paralleler Zweige oder am Ende eines Subprozesses) werden die Variablen dieses Geltungsbereichs verworfen. Um Variablen in einen darüber liegenden Geltungsbereich zu übernehmen, müssen Sie ein Output-Mapping konfigurieren. Dabei wird die Aufrufhierarchie vom aktuellen Element ausgehend so lange nach oben durchlaufen, bis ein Geltungsbereich gefunden wird, in dem diese Variable bereits existiert. In diesen wird der neue Wert dann übernommen. Für den Fall, dass es sich um eine komplett neue Variable handelt, wird diese dann in den Geltungsbereich des Gesamtprozesses geschrieben.

Auswirkungen in der Prozessüberwachung 

Bei der Ansicht eines Tokens werden immer die Variablen des aktuellen Geltungsbereichs angezeigt. Änderungen an den Variablen werden nur in diesen Geltungsbereich übernommen.

Die meisten Tokens besitzen einen eigenen Geltungsbereich. Die einzige Ausnahme bilden Benutzeraktivitäten, für die kein Input-/Output-Mapping konfiguriert wurde und die nicht parallel zu anderen Aktivitäten ausgeführt werden. Diese Tokens besitzen denselben Geltungsbereich wie das direkt darüber liegende Token.

In der Ansicht des Tokens ohne eigenen Geltungsbereich finden Sie eine Verknüpfung zum Token aus dem darüber liegenden Bereich. Wenn Sie diese Verknüpfung auswählen, können Sie die Variablen des verknüpften Geltungsbereichs anzeigen.