...
Parameter | Default value | Description | Valid examples | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Dieser Parameter wird benutzt, um den Pfad zum Template festzulegen, damit der ActionHandler danach im resources Order suchen kann. Um die erstellte Datei umzubenennen kann das Template selbst eine Prozessvariable enthalten. Vorausgesetzt das Template, Parameter hat die folgenden Werte:
Im Zielordner wird die Datei entsprechend gesucht.
|
| |||||||
|
| Dieser Parameter wird verwendet, um zu entscheiden, ob die Dokumente überschrieben werden sollen, wenn der Prozess durch eine Schleife ausgeführt wird. Wenn das ursprüngliche Template benötigt wird, sollte der Parameter |
| ||||||
| Der documentPrefix kann so verwendet werden, dass erstellte Dokumente immer den angegebenen Wert vor dem Vorlagennamen haben. |
| |||||||
|
| Wenn der Wert auf true gesetzt ist, werden alle Tabellenzeilen im xlsx-Template gelöscht, wenn die Variable in der ersten Spalte fehlt oder leer ist. Dadurch können unschöne leere Zeilen in dynamischen Inhalten vermieden werden (DOMRepeater). |
| ||||||
|
| Es kann entweder true oder false sein. Wenn dieser Wert auf true gesetzt ist, werden Prozessvariablen (die mit "bool" beginnen) wie folgt geändert:
|
| ||||||
|
| Dieser Parameter wird genutzt, um zu entscheiden, ob ein Boolean (true oder false) mit “Ja oder Nein“ ausgetauscht werden sollte. Wird diese Variable zu |
| ||||||
This parameter is used to determine the document name in the destination folder. This procedure is useful if the name of the created Word document should be different from the template name. The target parameter can contain process variables. | Suppose the user wanted to generate two reports in English and German. The Word template in the resource folder has the following name Dieser Parameter wird verwendet, um den Dokumentnamen im Zielordner zu bestimmen. Diese Vorgehensweise ist nützlich, wenn der Name des erstellten Word-Dokuments vom Vorlagennamen abweichen soll. Der Zielparameter kann Prozessvariablen enthalten. Angenommen, der Benutzer möchte zwei Berichte in Englisch und Deutsch erstellen. Die Word-Vorlage im Ressourcenordner hat den folgenden Namen: Note | Daher kann der Benutzer Excel-Dateien mit unterschiedlichen Namen aus derselben Excel-Vorlage erstellen.
|
| ||||||
|
| this parameter all system supported languages can be given in short form(e.gMit diesem Parameter können alle vom System unterstützten Sprachen in Kurzform angegeben werden (z.B. |
|
...
Setup the process
...
Aufbau
Um den Action Hander einzurichten, sind die folgenden Schritte erforderlich:
Richten Sie den Prozess ein
Erstellen oder Hochladen eines einfachen Workflows
View file name SimpleModel-version-2.zip Import form Formular Importieren
View file name 20240130_SimpleModel_v1.json
Upload the template in tenant admin resources Laden Sie die Vorlage in den Mandantenadministratorressourcen hoch.
View file name temp.xlsx
After the setup you should be able to seeNach dem Setup sollten Sie Folgendes sehen können:
...
...
Beispiel 1:
...
Select the process,
Upload the images in documents (upload at least an image called “im1.png” and another one )
Start a new instance with the below template
...
Ein einfaches Template erstellen
Wählen Sie den Prozess aus,
Laden Sie die Bilder in den Dokumenten hoch (laden Sie mindestens ein Bild mit dem Namen "im1.png" und ein weiteres hoch)
Starten Sie eine neue Instanz mit dem unten gezeigten Template
...
Die generierte Datei befindet sich in der Rubrik Dokumente zusammen mit den Bildern. Die generierte Datei sollte wie folgt aussehen:
| View file | ||
|---|---|---|
|
Variable substitution,
Conditional formatting,
Adding single images by name, and all images
Using excel functions,
Document prefix,
Document target,
Interpreting number as boolean, boolean as human and translation
| Note |
|---|
The variables must be the same as in the Excel template. |
Calling the execution of ExcelTemplateHandler from a REST api call endpoint
The ExcelTemplateHandler can be called from rest api using the below endpointIm obigen Beispiel haben wir aufgenommen:
Substitution von Variablen,
Formattierung anhand von Bedingungen
Hinzufügen einzelner Bilder nach Namen und aller Bilder
Benutzung von Excel-Funktionen
Präfix des Dokuments,
Ziel des Dokuments,
Interpretieren von Zahlen als boolesch, humane Auswertung eines Boolean und Übersetzung
| Note |
|---|
Die Variablen müssen mit denen in der Excel-Vorlage übereinstimmen. |
...
Aufrufen der Ausführung von ExcelTemplateHandler über eine REST-Schnittstelle
Der ExcelTemplateHandler kann über die REST-API mit dem folgenden Endpunkt aufgerufen werden.
| Code Block |
|---|
POST: [your server url here]/tim/api/templates
{
// Mandatory params
"processInstanceId": [YOUR PI ID HERE],
"template": [YOUR TEMPLATE PATH HERE],
//Optional params
"target": "",
"documentPrefix": "",
"locale": "",
"overwriteExisting": false,
"interpretNumbersAsBoolean": false,
"interpretBooleanAsHuman": false,
"removeEmptyTableRows": false,
"open": false
} |
...
Einbinden des ExcelTemplateHandlers in ein HTML-
...
Formular
The ExcelTemplateHandler can be integrated into a HTML-Form as a link, a button, or an image so that the participants can create a template at any time. For this, the following code must be integrated into the formDer ExcelTemplateHandler kann als Link, Button oder Bild in ein HTML-Formular eingebunden werden, so dass die Teilnehmer jederzeit eine Vorlage erstellen können. Dazu muss folgender Code in das Formular eingebunden werden:
| Code Block |
|---|
<button type="button" onbuttonclick="generateFileFromTemplate([{handler:'ExcelTemplateHandler',template:'temp.xlsx',attach:false,open:true,documentPrefix:'Prefix'}])">Generate Excel template</button> |
The Das Attribut "onbuttonclick" attribute defines which functions/parameters the handler should execute. See Parameters sections above.
Important when using HTML-Forms
Normally written text will be inherited, whereas variables will be overwritten if marked as definiert, welche Funktionen/Parameter der Handler ausführen soll. Weitere Informationen finden Sie in den Abschnitten "Parameter" oben.
...
Wichtig bei der Verwendung von HTML-Formularen
Normalerweise wird geschriebener Text vererbt, während Variablen überschrieben werden, wenn sie als ${Variable-ID}. To overwrite variables with content from the HTML form, you must use the variable's ID, such as markiert sind. Um Variablen mit Inhalten aus dem HTML-Formular zu überschreiben, müssen Sie die ID der Variablen, z. B.${Variable-ID}, within the text form fields. An exception to this rule applies to radio buttons, where you should use the variable name, like in den Textformularfeldern verwenden. Eine Ausnahme von dieser Regel gilt für Optionsfelder, bei denen Sie den Variablennamen wie ${Variable-Name}, instead of the variable ID anstelle der Variablen-ID verwenden sollten.
...