Wiki source code of Change counter

Hide last authors

version	line-number	content
2.2	1	{{figure image="change_counter_en.png" clear="h1"}}
	2	User interface for actions of type //Change counter//.
2.3	3	{{/figure}}
2.2	4
	5	Actions of type //Change counter// allows to change the value of a [[counter>>Formcycle.UserInterface.Data.Counter]], for example by incrementing or decrementing it by a certain value. The counter should have been created in the backend beforehand.
	6
	7	== Parameters ==
	8
	9	=== Counter change details ===
	10
	11	; Counter
	12	: [[Counter>>Formcycle.UserInterface.Data.Counter]] configured in the management interface.
	13	; Counting action
	14	: Change to be applied to the counter, when the action is performed. This can be counting up, counting down, or resetting to the initial value.
	15	; Step size
3.2	16	: Specification of the steps in which the counter is to change. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
2.2	17
	18	== Action variables ==
	19
3.3	20	Actions of type //Change counter// provide [[Action variables>>Formcycle.UserInterface.Variables\|\|anchor="HActionvariables"]] which can be used in subsequent actions.
2.2	21
	22	=== Standard action variables ===
	23
	24	; [%$<action name>.SUCCESS%]
	25	: Return whether action was successfully executed. Returns Boolean (true/false).
	26	; [%$<action name>.RESULT%]
	27	: Return all results provided by the action in structured form.
	28
	29	; [%$<action name>.ERROR_CODE%]
	30	: The error code thrown in case of an error in the action. Empty if no error occurred.
	31	; [%$<action name>.ERROR_MESSAGE%]
	32	: The thrown error message in the action's error case. Empty if no error occurred.
	33
	34	=== Action specific action variables ===
3.3	35
2.2	36	; [%$<actionname>.RESULT.newValue%]
	37	: The new value of the counter after the change.
	38	; [%$<ActionName>.RESULT.oldValue%]
	39	: The old value of the counter before the change.
	40	; [%$<ActionName>.RESULT.wasReset%]
	41	: Whether the counter was reset to its default value.
	42	; [%$<action name>.ERROR.message%]
	43	: Error code returned if the counter could not be found, an entered value does not match the required format, or if no or an unknown counter action is performed.