Skip to Content

Wiki source code of Change availability

Show last authors
1 {{figure image="change_availability_en.png" clear="h1"}}
2 Configuration interface for actions of the type //Change availability//.
3 {{/figure}}
4
5 Actions of type //Change availability// allows to switch the form online or offline. If a form is not available, it can neither be called nor submitted.
6
7 == Parameter ==
8
9 ; Type of change
10 : Specifies whether the form is switched offline or online.
11
12 == Action variables ==
13
14 Actions of type //Change Availability// provide [[action variables>>Formcycle.UserInterface.Variables||anchor="Action variables"]] which can be used in subsequent actions.
15
16 === Standard action variables ===
17
18 ; [%$<Actionsname>.SUCCESS%]
19 : Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false.
20 ; [%$<Actionsname>.RESULT%]
21 : Return all results provided by the action as JSON.
22
23 ; [%$<Actionsname>.ERROR_CODE%]
24 : In case of error the thrown error code of the action. Empty if no error has occurred.
25 ; [%$<Actionsname>.ERROR_MESSAGE%]
26 : In case of error the thrown error message of the action. Empty if no error has occurred.
27
28 === Action specific action variables ===
29
30 ; [%$<Actionsname>.RESULT.currentState%]
31 : Indicates whether the form is switched online or offline after this action is executed.
32 ; [%$<Actionsname>.RESULT.previousState%]
33 : Indicates whether the form is switched online or offline before this action is executed.
34 ; [%$<Actionsname>.RESULT.wasChanged%]
35 : Indicates whether the availability of the form has been changed. Returns Boolean (true/false).