... |
... |
@@ -10,8
+10,6 @@ |
10 |
10 |
* Das Generieren einer ID für einen Formularvorgang, die unabhängig von der FORMCYCLE-internen Prozess-ID ist. Dies ist speziell dann sinnvoll, wenn die ID einem bestimmten Muster folgen soll oder in regelmäßigen Abständen zurückgesetzt werden muss. |
11 |
11 |
* Das n-fache Durchlaufen der Aktionen eines Status, wobei //n// in Abhängigkeit einer Formulareingabe festgelegt wird. |
12 |
12 |
|
13 |
|
-Der Stand aller angelegten |
14 |
|
- |
15 |
15 |
Zudem ist es auch möglich, den aktuellen Wert eines Zählers über einen [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] in der Verarbeitung oder [[per AJAX>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.WebHome]] im Formular abzufragen. |
16 |
16 |
|
17 |
17 |
Jeder Zähler besitzt sowohl einen Namen als auch eine eindeutige [[UUID>>https://de.wikipedia.org/wiki/Universally_Unique_Identifier]]. Die UUID dient zur eindeutigen Identifikation Zählers und wird bei der Abfrage per AJAX verwendet. |
... |
... |
@@ -78,25
+78,25 @@ |
78 |
78 |
|
79 |
79 |
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: |
80 |
80 |
|
81 |
|
-{{code language="none"}} |
|
79 |
+{{code}} |
82 |
82 |
[%$DBCOUNTER.<Zählername>%] |
83 |
83 |
{{/code}} |
84 |
84 |
|
85 |
85 |
Um also etwa auf den Zähler mit dem Namen //test// zuzugreifen, muss der folgende Platzhalter genutzt werden: |
86 |
86 |
|
87 |
|
-{{code language="none"}} |
|
85 |
+{{code}} |
88 |
88 |
[%$DBCOUNTER.test%] |
89 |
89 |
{{/code}} |
90 |
90 |
|
91 |
91 |
Falls auf einen Zähler zugegriffen werden soll, bei dem nicht bekannt ist, ob es diesen schon gibt, muss der Startwert für den Zähler mit angegeben werden. Falls der Zähler noch nicht existiert, wird dann ein neuer Zähler mit diesem Startwert erstellt. Der Platzhalter baut sich dann nach folgendem Schema auf: |
92 |
92 |
|
93 |
|
-{{code language="none"}} |
|
91 |
+{{code}} |
94 |
94 |
[%$DBCOUNTER(<Zählername>, <Startwert>)%] |
95 |
95 |
{{/code}} |
96 |
96 |
|
97 |
97 |
Angenommen, der Zähler heiße //teilnehmer-2020-03-17// und soll den Wert //0// erhalten, falls er noch nicht existiert. Dann kann der folgende Platzhalter genutzt werden: |
98 |
98 |
|
99 |
|
-{{code language="none"}} |
|
97 |
+{{code}} |
100 |
100 |
[%$DBCOUNTER(teilnehmer-2020-03-17, 0)%] |
101 |
101 |
{{/code}} |
102 |
102 |
|
... |
... |
@@ -108,19
+108,19 @@ |
108 |
108 |
|
109 |
109 |
Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies ist etwa nützlich, wenn aus dem Formular heraus ein Zählwert per AJAX-Anfrage abgerufen werden soll. Die URL für das Servlet baut sich nach dem folgenden Schema auf: |
110 |
110 |
|
111 |
|
-{{code language="none"}} |
|
109 |
+{{code}} |
112 |
112 |
https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID> |
113 |
113 |
{{/code}} |
114 |
114 |
|
115 |
115 |
Falls also etwa FORMCYCLE lokal unter dem Pfad //xima-formcycle// installiert wurde, der Zähler in einem Formular des Mandanten mit der ID //1// verwendet wird und die UUID //bc49d3b0-f869-4e59-864e-ddcc2925ed63// besitzt, dann lautet die URL: |
116 |
116 |
|
117 |
|
-{{code language="none"}} |
|
115 |
+{{code}} |
118 |
118 |
https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63 |
119 |
119 |
{{/code}} |
120 |
120 |
|
121 |
121 |
Alternativ ist es auch möglich, statt der //client-id// die ID des Formulars zu verwenden. Diese IDs lediglich verwendet, um das Servlet-Aktions-Plugin zu bestimmen, welches ausgeführt werden soll, und werden von diesem konkreten Plugin nicht ausgewertet: |
122 |
122 |
|
123 |
|
-{{code language="none"}} |
|
121 |
+{{code}} |
124 |
124 |
https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID> |
125 |
125 |
{{/code}} |
126 |
126 |
|
... |
... |
@@ -141,14
+141,12 @@ |
141 |
141 |
; counter-initial |
142 |
142 |
: Optional. Initialer Wert des Counters, wenn dieser noch nicht existiert. Dieser Parameter darf nur angegeben werden, wenn auch //counter-name// angegeben wird. |
143 |
143 |
; counter-array |
144 |
|
-: Optional. Entweder //true// oder //false// (Standard). Wenn auf //true// gesetzt, darf der Parameter //counter-name// beziehungsweise //id// mehrfach angegeben werden. Es wird dann Array mit den Werten den Informationen zu den einzelnen Zählern angegeben. Diese Option sollte genutzt werden, wenn in einem Formular per AJAX mehrere Zähler auf einmal abgefragt werden sollen. So kann die Anzahl an HTTP-Anfrage reduziert werden. |
|
142 |
+: Optional. Liefert statt einem JSON-Objekt ein Array zurück. In dem können mehrere Namen oder UUID übergeben werden. Dieser Parameter darf nur angegeben werden, wenn auch //counter-name// angegeben wird. |
145 |
145 |
|
146 |
146 |
=== HTTP-Antwort |
147 |
147 |
|
148 |
|
-Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Falls der Parameter //counter-array// auf //true// gesetzt wurde, wird stattdessem ein JSON-Array zurückgegeben, wobei jeder Eintrag ein JSON-Objekt mit den unten beschriebenen Einträgen ist. |
|
146 |
+Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Dieses JSON-Objekt hat die folgenden Einträge: |
149 |
149 |
|
150 |
|
-Das JSON-Objekt hat die folgenden Einträge: |
151 |
|
- |
152 |
152 |
; Status |
153 |
153 |
: Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen: |
154 |
154 |
:; Msg |