Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core workflow 3.0


Schreibweise von Variablen

In dieser Dokumentation erfahren Sie, wie Sie Variablen in Knoten korrekt schreiben, damit Sie sie in Workflows verwenden können.

Hinweis: Die Variablennamen müssen gültige JavaScript-Variablennamen sein:

  • Variablennamen dürfen nur Groß- und Kleinbuchstaben, Ziffern und Unterstrich (_) aus dem ASCII-Zeichensatz enthalten.
  • Der Name darf jedoch nicht mit einer Ziffer und sollte nicht mit einem Großbuchstaben beginnen.
  • Die Variablennamen dürfen keine Schlüsselwörter oder reservierte Wörter von JavaScript enthalten, etwa var, for, if, let, const, function, class.

Eine vollständige Liste der reservierten Wörter und weitere Informationen finden Sie in der ECMAScript-Spezifikation.

Arten von Schreibweisen


Insgesamt gibt es drei Arten, wie Sie Variablen in Knoten verwenden können:

Schreibweisen verwenden


Wann und wie Sie die Schreibweisen verwenden, lernen Sie nachfolgend kennen.

Variablen als Platzhalter verwenden

Bei dieser Schreibweise wird zwischen dem von JavaScript im Standard mitgelieferten Format date und normalen Variablen unterschieden. Weitere Informationen zu date finden Sie im Web, etwa unter:

Hinweis: Sollten Sie Platzhalter verwenden, ist dies nur im Editor möglich, nicht als Expression.


Platzhalter in Form von „date“

Mithilfe von date ist es etwa möglich, den Parameter Pfad, wie er etwa beim Knoten Ablage vorkommt, mit einem Datum anzugeben:

Verwendung von Platzhaltern im Editor

Als Datum würde hier immer das aktuell gültige Datum genommen werden. Legt das System in einem Workflow etwa über den Ablage-Knoten eine Rechnung am 30.06.2021 ab, würde der Dateiname der Rechnung folglich lauten:

LI-12345/Rechnungen-2021/06/30


Platzhalter in Form von „normalen“ Variablen

Neben dieser Angabe können Sie jede andere beliebige Variable in Form eines Platzhalters angeben. Die Variable muss allerdings zu diesem Zeitpunkt bereits existieren. Legt das System etwa über den Ablage-Knoten einen Ordner an, könnten Sie den Pfad zum Ordner folgendermaßen nennen:

/agorum/roi/Files/Lieferantenakten/${test_lieferantennummer}

Der fett markierte Teil enthält die Variable test_lieferantennummer in Form eines Platzhalters. Die Variable muss wie oben beschrieben bereits vorhanden sein, etwa können Sie die Variable zuvor über einen Skript-Knoten erstellen, damit Sie dann im nächsten Knoten wie oben beschrieben für die Ordneranlage verfügbar ist.

Variablen im Editor und als Expression verwenden


Im Editor

Variablen tragen Sie im Editor eines Parameters immer dann ein, wenn Sie auf einen Parameter stoßen, der bereits einen Variablennamen verlangt. Dazu gehören etwa folgende Parameter:

Ein- und Ausgangsvariablen

Die Eingabe verlangt bereits einen Variablennamen. In diesem Falle bleiben Sie im Editor und stellen nicht auf Expression um.

Sie würden hier also etwa die beiden Parameter folgendermaßen befüllen:

Gefüllte Ein- und Ausgangsvariablen


Als Expression

In allen anderen Fällen stellen Sie auf Expression um.


Beispiel: Generelles Verhalten von Expressions

Sie definieren im Workflow folgende Variable mit folgendem Wert:

token.variables.dataVariableName = 'outputKI';

Sie geben in einem Knoten bei der Datenvariable folgende Expression an:

token.variables.dataVariableName

Der Knoten schreibt das Ergebnis jetzt in die Variable outputKI.


Beispiel: Knoten „Bedingung (Objekte)“

Beim Knoten Bedingung (Objekte) und dem Parameter Bedingung müssen Sie auf Expression umstellen:

Variable als Expression

Hier sehen Sie bereits, dass das System eine Expression verlangt, Expression ist vorausgewählt. Wann immer Sie auf Expression umschalten, verwenden Sie für Variablen folgende Schreibweise:

token.variables.meineVariable

Ihre Variable erhält hier also den Präfix token.variables. In dem obigen Fall könnte der Parameter Bedingung etwa folgendermaßen befüllt werden:

Gefüllte Variable als Expression

Hier prüft das System etwa die Variable Hauptkundenakte auf ihre Länge hin, d. h. auf die Anzahl der enthaltenen Objekte. Wann immer eine solche Prüfung in einem Parameter nötig ist, müssen Sie auf Expression umschalten.

Durch die Nutzung von Expressions sind dynamischere Einstellungen möglich, als es beim Editor der Fall ist.

Hinweis: Sind Sie sich nicht sicher, welche Einstellung für Ihre Konfiguration am besten geeignet ist, schauen Sie sich die Hilfe (Fragezeichen-Symbol) bei den Parametern an. Oftmals finden Sie dort Anwendungsbeispiele für den Editor / Expression.

Editor: Verhalten im Falle von „token.variables“

Sollten Sie im Editor trotzdem die Schreibweise mit dem Präfix token.variables verwenden, sucht das System nach genau dieser Variablen, also etwa token.variables.meineVariable, sobald der Workflow gestartet wird und das System den Knoten erreicht. Diese Variable existiert jedoch nur in der Form meineVariable, also ohne Präfix. Der Workflow würde die Variable nicht finden und mit einem Fehler abbrechen.


Beispiel

Folgende Metadaten sind in der Workflowinstanz gespeichert:

token.variables: {
 sys_acw_attachment: [],
 meineVariable: 'XYZ'
}

Sie tragen nun die Variable meineVariable in die Datenvariable als Expression ein:

token.variables.meineVariable

Der Workflow sucht in den token.variables nach diesem nicht existierenden Variablennamen token.variables.meineVariable und wird nicht fündig:

token.variables: {
 sys_acw_attachment: [],
 meineVariable: 'XYZ',
 "token.variables.meineVariable": 'Ich existiere nicht'
}

Expression: Verhalten im Falle von fehlendem Präfix „token.variables“

Sollten Sie in der Expression die Schreibweise mit dem Präfix token.variables vergessen und die Variable nicht definiert sein, sucht das System nach den Variablen, die Sie in den Knoten angegeben haben, sobald der Workflow gestartet wird.


Beispiel

Im Knoten Dokument-Vorlage befüllen haben Sie den Parameter Dokument-Vorlage mit der Variablen documentTemplate befüllt und auf Expression umgestellt:

Angegebene Variable ohne Präfix als Expression

Sollten Sie die Variable nun nicht definiert haben, etwa weil Sie vergessen haben, diese zu erstellen, wirft das System eine Fehlermeldung, sobald der Workflow gestartet wird:

Fehlermeldung bei fehlendem Präfix und nicht definierter Variable