... |
... |
@@ -69,67
+69,67 @@ |
69 |
69 |
|
70 |
70 |
Regarding resetting the counter in daily intervals: Please note that the counter is not reset by background task, but only when the workflow action //counter// is executed. Or, to be more precise, the counter value is reset (instead of being incremented or decremented), when the time points at which the counter should have been reset contains at least one point that lies between the last point in time the counter value was modified and the current point in time. |
71 |
71 |
|
72 |
|
-; 1 - Bedingung |
73 |
|
-: Hier kann festgelegt werden, wann und unter welchen Umständen der Zähler zurückgesetzt werden soll. |
74 |
|
-:; Zähler größer gleich |
75 |
|
-:: Nur verfügbar, wenn als Zählaktion //Hochzählen// gewählt wurde. Der Zähler wird auf den Startwert zurückgesetzt, wenn durch die aktuelle Aktion der Wert des Zählers so geändert wird, dass dieser größer oder gleich dem in (2) festgelegten Wert ist. |
76 |
|
-:; Zähler kleiner gleich |
77 |
|
-:: Nur verfügbar, wenn als Zählaktion //Herunterzählen// gewählt wurde. Der Zähler wird auf den Startwert zurückgesetzt, wenn durch die aktuelle Aktion der Wert des Zählers so geändert wird, dass dieser kleiner oder gleich dem in (2) festgelegten Wert ist. |
78 |
|
-:; täglich |
79 |
|
-:: Der Zähler wird jeden Tag zur bei (2) gewählten Uhrzeit auf den Startwert zurückgesetzt. |
80 |
|
-:; wöchentlich |
81 |
|
-:: Der Zähler wird an jedem unter (2) gewählten Wochentag zu der unter (3) gewählten Uhrzeit zurückgesetzt. |
82 |
|
-:; monatlich |
83 |
|
-:: Der Zähler wird jeden Monat zum unter (2) gewählten Tag zu der unter (3) gewählten Uhrzeit zurückgesetzt. |
84 |
|
-:; jährlich |
85 |
|
-:: Der Zähler wird jedes Jahr zum unter (2) und (3) gewählten Tag zu der unter (4) gewählten Uhrzeit zurückgesetzt |
|
72 |
+; 1 - Condition |
|
73 |
+: Lets you choose when and how the counter should be reset. |
|
74 |
+:; Counter greater than or equal |
|
75 |
+:: Available only when the counting action was set to //count up//. The counter is reset to its initial value when, after the counter was incremented, its value is now greater than or equal to the limit entered in (2). |
|
76 |
+:; Counter less than or equal |
|
77 |
+:: Available only when the counting action was set to //count down//. The counter is reset to its initial value when, after the counter was decremented, its value is now less than or equal to the limit entered in (2). |
|
78 |
+:; daily |
|
79 |
+:: The counter is reset each day at the time of day as entered in (2). |
|
80 |
+:; weekly |
|
81 |
+:: The counter is reset at each of the days of the week selected in (2); at the time of day as entered in (2). |
|
82 |
+:; monthly |
|
83 |
+:: The counter is reset each month at the date and time of day as entered in (2) and (3). |
|
84 |
+:; yearly |
|
85 |
+:: The counter is reset each year the the day, month and time of day as entered in (2), (3), and (4), respectively. |
86 |
86 |
|
87 |
|
-=== Allgemeine Rückgabeparameter === |
|
87 |
+=== General return parameters === |
88 |
88 |
|
89 |
89 |
{{figure image="dbcounter_plugin_action_return_parameters_en.png"}} |
90 |
|
-Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind. |
|
90 |
+Settings for the return parameters of the counter action. You can access the returned values via variables. |
91 |
91 |
{{/figure}} |
92 |
92 |
|
93 |
|
-Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. Dies kann über Aktionsplatzhalter geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].count%]// auf den aktuellen Zählwert zugegriffen werden, falls unter (3) bei den allgemeinen Rückgabeparameter der Wert //count// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar: |
|
93 |
+Sometimes it may be necessary to access the new value of the counter. To do so, you can use action variables for accessing the returned values of an action. The section //general return parameters// lets you configure the key you need to use for accessing the return values. For example, assume a counter action was named //CountUp//. Then you can use the variable //[%$CountUp.RESULT[0].count%]// to access the current counter value, provided you entered the key //count// in the input field (3). The following return values are available: |
94 |
94 |
|
95 |
95 |
; 1 - ResultCode |
96 |
|
-: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich: |
|
96 |
+: A numerical value that indicates whether the counter action was successful or not. The following result codes are possible: |
97 |
97 |
:; 1 (OK) |
98 |
|
-:: Die Zählaktion wurde erfolgreich abgearbeitet. |
|
98 |
+:: The counter action was processed successfully. |
99 |
99 |
:; 10 (UNKNOWN_ACTION_ERROR) |
100 |
|
-:: Die Zählaktion kann nicht ausgeführt werden, da eine unbekannte Zählaktion ausgewählt wurde. Aktuell werden die Zählaktionen //Hochzählen//, //Herunterzählen// und //Auf den Startwert zurücksetzen// unterstützt. |
|
100 |
+:: The counter action could not be processed, an unknown counting action was selected. The currently supported counting actions are //count up//, //count down// and //reset counter to start value//. |
101 |
101 |
:; 11 (PARSING_ERROR) |
102 |
|
-:: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde. |
|
102 |
+:: A settings does not conform to the expected data type or syntax; such as when a letter was entered for the initial value (instead of a number). |
103 |
103 |
:; 40 (INTERNAL_ERROR) |
104 |
|
-:: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann. |
|
104 |
+:: The counter action was not successful. The type of error cannot be specified more closely. |
105 |
105 |
; 2 - ResultMessage |
106 |
|
-: Eine englische Beschreibung des Resultats (Erfolg oder Fehler). |
|
106 |
+: An English description of the result (success or error). |
107 |
107 |
; 3 - Counter |
108 |
|
-: Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde. |
|
108 |
+: The new numerical value of the counter, after the counting action was applied. |
109 |
109 |
; 4 - IsReset |
110 |
|
-: Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde. |
|
110 |
+: Either //true//, when the counter was reset during the current action; or //false// if it was not reset. |
111 |
111 |
; 5 - CounterAfterReset |
112 |
|
-: Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen. |
|
112 |
+: In case the counter was reset: The numerical value of the counter before the reset. |
113 |
113 |
|
114 |
|
-== Systemplatzhalter-Plugin == |
|
114 |
+== System variable plugin == |
115 |
115 |
|
116 |
116 |
{{figure image="dbcounter-plugin-placeholder_en.png"}} |
117 |
|
-Ein Beispiel für den Platzhalter zum Auslesen des Zählwerts. Hier wird ein Zähler ausgelesen, der die Anzahl an Anmeldungen für eine Veranstaltung zählt. Dann wird geprüft, ob der Zählwert die maximale Anzahl an Anmeldungen übersteigt. Basierend auf dieser Prüfung kann dem Nutzer dann ein Fehler angezeigt werden, falls die Veranstaltung bereits ausgebucht ist. Hierbei handelt es sich um eine serverseitige Prüfung zur Validierung, bereits im Formular bei der Anmeldung sollte dem Nutzer natürlich schon die Information gegeben werden, ob überhaupt noch Plätze frei sind. |
|
117 |
+An example for how a counter value can be accessed via variables. Here we read the value of a counter that keeps track of the number of reservations for an event. When the user submits the reservation form, we check the current value of the counter against the limit for that event. When the limit is exceeded, we can return an appropriate error message to the users. Please note that this is meant as a server-side validation - to make the form user-friendly, you should indicate the number of free slots in the form itself. |
118 |
118 |
{{/figure}} |
119 |
119 |
|
120 |
|
-Nach Installation des Plugins ist ein neuer [[Systemplatzhalter>>doc:Formcycle.UserInterface.Variables]] verfügbar, über den auf den aktuellen Wert eines Zählers zugegriffen werden kann. Dies ist etwa nützlich, um in einer Aktionsbedingung den Zählwert nutzen und prüfen zu können. Der Platzhalter baut sich nach dem folgenden Schema auf: |
|
120 |
+Once the plugin is installed, you can access the current value of the plugin with a [[system variable>>doc:Formcycle.UserInterface.Variables]]. This can be used, for example, to access the counter value in the condition of a workflow action and compare it with a submitted value. The system variable has got the following pattern: |
121 |
121 |
|
122 |
122 |
{{code}} |
123 |
|
-[%$DBCOUNTER.<Zählername>%] |
|
123 |
+[%$DBCOUNTER.<CounterName>%] |
124 |
124 |
{{/code}} |
125 |
125 |
|
126 |
|
-Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden: |
|
126 |
+So to access the value of a counter named //test//, you can use the following variable: |
127 |
127 |
|
128 |
128 |
{{code}} |
129 |
129 |
[%$DBCOUNTER.test%] |
130 |
130 |
{{/code}} |
131 |
131 |
|
132 |
|
-== Servlet-Aktions-Plugin == |
|
132 |
+== Servlet action plugin == |
133 |
133 |
|
134 |
134 |
{{figure image="dbcounter_plugin_servlet_action.png"}} |
135 |
135 |
Beispiel zum Auslesen eines Zählers im Formular mittels AJAX. Die URL wird anhand der im Formular zur Verfügung stehenden Metadaten aufgebaut. Hiermit wird vermieden, die URL hart im Quelltext zu hinterlegen, was zu Fehlern führt, wenn sich etwa der Server oder der Kontextpfad ändern sollte. |