getWorkflowVariableByName
- Team Dodo
- Technische Redaktion
Einleitung
Die Methode getWorkflowVariableByName erlaubt über Workflow-Variablen auf die Daten des Workflows, aus welchem der modale Dialog geöffnet wurde, zuzugreifen, sodass diese im modalen Dialog verwendet werden können. Die Workflow-Variablen können an Maskenfelder gebunden sein, oder aber unabhängig von Maskenfeldern sein.
Verfügbar: ab enaio® webclient 11.10.7
Beispiel
Beispiel (TypeScript)
let workflowVariable = await lib.getWorkflowVariableByName({
name: "<NameOfTheWorkflowVariable>"
}); Workflow-Variablen werden über ihren zugewiesenen Namen identifiziert (es stehen keine internen Namen zur Verfügung).
Beachten Sie bitte die Informationen zur "Zwischenspeicherung von Feld- und Variablenwerten".
Parameter
Parameter | Type | Optional | Mögliche Werte | Default | Beschreibung |
|---|---|---|---|---|---|
JSON | object | Nein |
|
| Ein Javascript-Objekt, welches als Parameter den Namen der Workflow-Variable enthält. |
Rückgabewert
Die Methode gibt ein JSON-Objekt zurück, das die folgenden Informationen enthält:
Parameter | Type | Beschreibung | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fieldInternalName | string | Interner Name des Feldes auf der Workflow-Maske, dem die Workflow-Variable zugeordnet ist. | |||||||||||||||||||||||||||||||||
name | string | Name der Workflow-Variable. | |||||||||||||||||||||||||||||||||
id |
| ID der Workflow-Variable. | |||||||||||||||||||||||||||||||||
mode |
| Der Schreibschutz-Status der Workflow-Variable:
| |||||||||||||||||||||||||||||||||
type | string | Der Feldtyp (z. B. "text"). Typ "list<record>" für Tabellen ("grid data"). | |||||||||||||||||||||||||||||||||
value | string/array/any | Der Wert des Feldes, oder ein Array mit Werten für eine Tabelle. Ausgabewerte variieren in Inhalt und Format basierend auf den Datentypen des Feldes und dem Status der Werte.
| |||||||||||||||||||||||||||||||||
initialValue | Same as "value" | Der initiale Wert des Feldes. |
Beispiel - normales Feld
{
"id": "<id>",
"name": "<name>",
"fieldInternalName": "<FieldInternalName>",
"mode": "<mode>",
"type": "<type>",
"value": "<value>",
"initialValue": "<initalValue>"
}Beispiel - Tabellenfeld
{
"id": "ID12345",
"name": "Tabelle",
"fieldInternalName": "tabelle",
"mode": "3",
"type": "list<record>",
"value": [
[
"Banane",
"20",
"04/03/2024",
"5.00"
]
],
"initialValue": [
[
"Apfel",
"30",
"04/03/2024",
"2.00"
]
]
}Fehlerbehandlung
In Fällen, in denen die Methode getWorkflowVariableByName auf Fehler oder bestimmte Bedingungen stößt, die eine erfolgreiche Ausführung verhindern, gibt diese ein JSON-Fehlerobjekt zurück, um den Entwicklern eine klare Rückmeldung zu geben.
Die Fehlerantwort enthält einen errorCode und eine errorDescription, die für die Fehlersuche und Problemlösung verwendet werden können.
Parameter | Type | Beschreibung |
|---|---|---|
errorCode | integer | Der dem spezifischen Szenario entsprechende Fehlercode. |
errorDescription | srting | Eine beschreibende Fehlermeldung, die auf das Problem hinweist. |
Beispiel - Keine Variable mit dem angegebenen Namen gefunden.
{
"errorCode": 4,
"errorDescription": "Workflow variable with the name (nonExistentField) is not present."
}Fehlercodes
Code | Beschreibung |
|---|---|
1 | Allgemeiner Fehlercode für alle anderen Laufzeitfehler. |
4 | Eine Workflow-Variable mit diesem Namen (<name>) ist nicht vorhanden. |
Besonderer Fall
Bitte beachten Sie, dass beim Zugriff auf die Workflow-Maske über einen Direktlink (über eine URL - "Integration mit anderen Systemen") möglicherweise nicht die erwarteten Werte von der Methode getWorkflowVariableByName geliefert werden, was auf eine bekannte Einschränkung zurückzuführen ist. Eine optimale Funktionalität wird gewährleistet, wenn auf die Workflow-Maske über das Hauptmenü Eingangskörbe" | "Meine Eingänge" zugegriffen wird.