Einleitung

Die Methode setWorkflowVariableByName ermöglicht es für die aktuelle Workflow-Aktivität Werte in Workflow-Variablen zu schreiben und damit ggf. auch in das jeweils verbundene Feld auf der Workflow-Maske.

Verfügbar: ab enaio® webclient 11.10.7

1 Einleitung
2 Beispiele
3 Parameter
4 Rückgabewert
5 Fehlerbehandlung
- 5.1 Fehler-Codes

Beispiele

Beispiel (TypeScript)

await lib.setWorkflowVariableByName({
	"name": "<NameOfTheWorkflowVariable>",
	"value": "<ValueForTheWorkflowVariable>"
});

Workflow-Variablen werden über ihren zugewiesenen Namen identifiziert (es stehen keine internen Namen zur Verfügung).

Parameter

Parameter	Type	Optional	Beschreibung

Parameter

Type

Optional

Beschreibung

JSON

object

Nein

Ein Javascript-Objekt, welches als Parameter den Namen der Workflow-Variable und den zu setzenden Wert enthält.
Alle zu setzende Werte müssen vom Typ String sein.
Datum- und Zeitwerte müssen im ISO8601 übergeben werden.

Data Type	Variable Type	Output Value Format
`date`	^date	`YYYY-MM-DD(ISO Format)`
`datetime`	`datetime`	`YYYY-MM-DDTHH:MM:SS(ISO Format)`
`time`	^time	`HH:MM:SS(ISO Format)`
`text`	^string	`<text value>`
`checkbox`	^{string \| integer}	1 (checked), 0 (unchecked)
`radio`	^{string \|integer}	Im Zusammenhang mit einem Gruppenfeld wird jeder Optionsschaltfläche (Radio button) ein Wert zugewiesen, der seinem Index entspricht. In einem Gruppenfeld mit drei Optionsschaltflächen sind die zugewiesenen Werte zum Beispiel 0, 1 und 2. Um den Wert für eine bestimmte Optionsschaltfläche innerhalb der Gruppe festzulegen, verwenden Sie den entsprechenden Indexwert. Um beispielsweise den Wert für die erste Optionsschaltfläche festzulegen, verwenden Sie 0. Für die weiteren Optionsschaltflächen der Gruppe gehen Sie entsprechend vor.
`table`	`list<record>`	`[string[]]` - mehrdimensionales Array von Strings. Hinweis: Wenn die Tabellenspalten unterschiedliche Datentypen haben, müssen die Parameterwerte dem in doppelten Anführungszeichen angegebenen Format entsprechen, das als `String` betrachtet wird. Wenn zum Beispiel eine der Tabellenspalten vom Typ `date` ist, muss der Wertparameter im ISO-Datumsformat sein.
	^list<type>	Verschiedene Listentypen. z.B.: list<string>, list<date>, list<record> usw. Der Eingabewert muss das Format eines 1-dimensionales Array haben, wie z. B. ["value"], ["1", "2"], ["2024-05-31"] usw.
	^record	Muss die Struktur der Record-Variable genau abbilden. Nähere Informationen in Recordparameter .

Validierung der Werte

Bitte beachten Sie, dass es keine Validierung der im Parameter "value" übergebenen Werte bei der Ausführung der Methode setWorkflowVariableByName stattfindet, Diese wurde nicht implementiert, um mit der Workflow Parameter API konsistent zu bleiben.

Rückgabewert

Die Methode gibt ein leeres JSON-Objekt zurück:

Parameter	Type	Beschreibung

Parameter	Type	Beschreibung
Nicht anwendbar	Record<string, never>	Ein Objekttyp mit String-Schlüsseln und -Werten vom Typ "never", der effektiv ein leeres Objekt angibt. Die Methode gibt ein leeres Objekt {} mit diesem angegebenen Typ zurück.

Fehlerbehandlung

In Fällen, in denen die Methode setWorkflowVariableByName auf Fehler oder bestimmte Bedingungen stößt, die eine erfolgreiche Ausführung verhindern, gibt die Methode ein JSON-Fehlerobjekt zurück, um den Entwicklern eine klare Rückmeldung zu geben. Diese Fehlerantwort enthält einen errorCode und eine errorDescription, die für die Fehlersuche und Problemlösung verwendet werden können.

Parameter	Type	Beschreibung

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."
}

Fehler-Codes

Code	Beschreibung

Code	Beschreibung
1	Allgemeiner Fehlercode für alle anderen Laufzeitfehler.
4	Eine Workflow-Variable mit diesem Namen (<name>) ist nicht vorhanden.
10	Der Feldwert hat das falsche Format und kann nicht eingestellt werden.