Changes for page Protokolleintrag anlegen

From version 1.1
edited by awa
on 03.08.2022, 21:01
Change comment: There is no comment for this version
To version 4.1
edited by Nils Schweigert
on 05.08.2022, 18:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.awa
1 +XWiki.nsc
Content
... ... @@ -1,3 +1,43 @@
1 1  {{version major="7" minor="2" /}} This feature is scheduled to be released with {{formcycle/}} version 7.2.
2 2  
3 -TBD
3 +{{figure image="logEntry_en.png" clear="h1"}}
4 +Configuration interface for the action of type //create log entry//.
5 +{{/figure}}
6 +{{figure image="logEntryDemo_en.png" clear="h1"}}
7 +Created log entry with the severity of level //warning//.
8 +{{/figure}}
9 +
10 +Actions of type //create log entry// allow you to create custom entries in the [[Process log>>doc:Formcycle.UserInterface.Protocol]].
11 +
12 +==Parameters==
13 +
14 +===Informations of the log entry===
15 +; Name
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 +; Comments
20 +: The comments of the log entry to create. The comments can later be seen on the log entry.
21 +
22 +== Actionvariables ==
23 +
24 +Actions of type //create log entry// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
25 +
26 +=== Standard action variables ===
27 +
28 +; [%$<action name>.SUCCESS%]
29 +: Return whether action was successfully executed. Returns Boolean (true/false).
30 +; [%$<action name>.RESULT%]
31 +: Return all results provided by the action in structured form.
32 +
33 +; [%$<action name>.ERROR_CODE%]
34 +: The error code thrown in case of an error in the action. Empty if no error occurred.
35 +; [%$<action name>.ERROR_MESSAGE%]
36 +: The thrown error message in the action's error case. Empty if no error occurred.
37 +
38 +=== Action specific action variables ===
39 +
40 +; [%$<action name>.RESULT.level%]
41 +: The severity of the log entry.
42 +; [%$<action name>.RESULT.comments%]
43 +: The comments the log entry was given.