Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Dokument-Vorlage befüllen

Interne ID: agorum.office.fill

Sie können mit diesem Knoten ein Office-Dokument als Vorlage verwenden und darin befindliche Platzhalter mit Werten aus agorum core befüllen.

Der Knoten basiert auf der JavaScript-Bibliothek office/fill-template.

Aussehen des Knotens

Verhaltensweise


Erreicht das System den Knoten im Workflow, prüft das System die angegebenen Parameter. Das System liest die im Parameter Datenvariable enthaltenen Daten ein. Auf Basis der im Parameter Dokument-Vorlage angegebenen Vorlage erzeugt das System daraus neue Dokumente. Diese schreibt das System anschließend in den Parameter Ausgangsvariable. Die Dokumente können danach in weiteren Schritten / Knoten verwendet werden, etwa im Knoten Ablage, um die Datei direkt an einen finalen Ablageort zu verschieben.

Endpoints


Standard Veränderbar? Weitere Endpoints möglich?
Default (Inlet) Nein, kann nur ausgeblendet werden. nicht, nicht nötig
Default (Outlet) Nein, kann nur ausgeblendet werden. nicht, nicht nötig

Parameter


Parameter Beschreibung Beispiel
Dokument-Vorlage Definiert die Datei, die als Vorlage für das Befüllen der Platzhalter dient. Dokument-Vorlage
Platzhalter entfernen Definiert, ob Platzhalter, deren Werte nicht definiert sind, entfernt werden.

Standardmäßig ist diese Option aktiv.
Platzhalter entfernen
Füll-Funktion Definiert, über welche Füll-Funktion die Vorlage befüllt wird (simpleFill oder domFill).

Standardmäßig verwendet der Knoten die Füll-Funktion domFill.
Füll-Funktion
Datenvariable Definiert, wo die Daten liegen, die der Knoten verarbeitet.
  • Als Eingabe wird der Name der Variable erwartet, in der die Daten liegen.
  • Der Aufbau einer Datenvariable ist identisch zum Aufbau einer Ausgangsvariable.
Datenvariable
Ausgangsvariable Definiert eine Ausgangsvariable, die das neue befüllte Dokument enthält.

Tipp: Verwenden Sie die Variablenauswahl, um einen Überblick über alle nutzbaren Variablen zu erhalten. 

Dokument-Vorlage


Im Editor

Im Editor können Sie eine ID, eine UUID oder den vollständigen Pfad eines Office-Dokuments angeben.


Beispiele

ID:

1247295

UUID:

9cb6dcc0-4ac3-11eb-9c51-02420a0a0005

Vollständiger Pfad:

/agorum/roi/Files/Demo/.../template.docx


Als Expression

Bei der Expression muss das Ergebnis einer Zeichenkette entsprechen, die die gewünschte Dateiendung enthält. Dabei können sowohl feste Werte als auch Variablen des aktuellen Tokens verwendet werden.


Beispiele

ID:

'1247295'

UUID:

'9cb6dcc0-4ac3-11eb-9c51-02420a0a0005'

Vollständiger Pfad:

'/agorum/roi/Files/Demo/.../template.docx'

Variable des aktuellen Tokens:

token.variables.officeFill.templateFile

Platzhalter entfernen 


Im Editor

Im Editor aktivieren oder deaktivieren Sie diese Funktion, indem Sie diese anhaken oder den Haken entfernen.

Standardmäßig ist diese Option aktiv.


Als Expression

Als Expression muss das Ergebnis ein Boolean-Wert (true = wahr oder false = nicht wahr) aufweisen. Dabei können sowohl feste Werte als auch Variablen des aktuellen Tokens verwendet werden.


Beispiele

true
false

Variable des aktuellen Tokens:

token.variables.officeFill.enableClearEmpty

Füll-Funktion


Im Editor

Im Editor wählen Sie die gewünschte Funktion (simpleFill oder domFill) aus.


Als Expression

Bei der Expression muss das Ergebnis eine Zeichenkette sein, die den Namen einer verfügbaren Füll-Funktion enthält. Dabei können sowohl feste Werte als auch Variablen des aktuellen Tokens verwendet werden.


Beispiele

Variante 1:

'simpleFill'
'domFill'

Variable des aktuellen Tokens:

token.variables.officeFill.fillFunctionName

Datenvariable

Der Aufbau einer Datenvariable ist identisch zum Aufbau einer Ausgangsvariable.

Für generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.


Im Editor

Im Editor geben Sie den Namen der Workflow-Variable an. Das System platziert die Variable automatisch in der Variable des Tokens (token.variables).

dataVariable


Als Expression

Wenn Sie diesen Parameter als Expression angeben, geben Sie den vollständigen Pfad zur Variable an, von der das System den eigentlichen Namen der gewünschten Variable lesen soll.

'token.variables.nameOfDataVariable'