Wiki source code of Protokolleintrag anlegen


Hide last authors
gru 11.4 1 {{version major="7" minor="2" /}} This action is available from {{formcycle/}} version 7.2.0 onwards.
awa 1.1 2
gru 11.4 3 {{figure image="logEntry_en.png" clear="h1"}}
4 Configuration interface for the action of type //create log entry//.
awa 4.2 5 {{/figure}}
gru 11.4 6 {{figure image="logEntryDemo_en.png" clear="h1"}}
7 Created log entry with the severity of level //warning//.
Nils Schweigert 7.1 8 {{/figure}}
Nils Schweigert 4.1 9
gru 11.4 10 Actions of type //create log entry// allow you to create custom entries in the [[Process log>>doc:Formcycle.UserInterface.Protocol]].
Nils Schweigert 4.1 11
gru 11.4 12 ==Parameters==
Nils Schweigert 4.1 13
gru 11.4 14 ===Informations of the log entry===
Nils Schweigert 9.2 15 ; Name
gru 11.4 16 : The name of the action, which doubles as the name of the log entry to create.
17 ; Severity
18 : The severity level of the log entry to create. The severity allows you to filter the [[Log>>doc:Formcycle.UserInterface.Protocol]] accordingly.
19 : Possible values are: Info, Warning, Error
20 ; Comments
21 : The comments of the log entry to create. The comments can later be seen on the log entry.
Nils Schweigert 4.1 22
gru 11.4 23 == Actionvariables ==
Nils Schweigert 4.4 24
gru 11.4 25 Actions of type //create log entry// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
Nils Schweigert 4.4 26
gru 11.4 27 === Standard action variables ===
Nils Schweigert 4.4 28
gru 11.4 29 ; [%$<action name>.SUCCESS%]
30 : Return whether action was successfully executed. Returns Boolean (true/false).
31 ; [%$<action name>.RESULT%]
32 : Return all results provided by the action in structured form.
Nils Schweigert 4.4 33
gru 11.4 34 ; [%$<action name>.ERROR_CODE%]
35 : The error code thrown in case of an error in the action. Empty if no error occurred.
36 ; [%$<action name>.ERROR_MESSAGE%]
37 : The thrown error message in the action's error case. Empty if no error occurred.
Nils Schweigert 4.4 38
gru 11.4 39 === Action specific action variables ===
40
41 ; [%$<action name>.RESULT.level%]
42 : The severity of the log entry.
43 ; [%$<action name>.RESULT.comments%]
44 : The comments the log entry was given.