... |
... |
@@ -131,9
+131,10 @@ |
131 |
131 |
[%$DBCOUNTER.test%] |
132 |
132 |
{{/code}} |
133 |
133 |
|
134 |
|
-== Servlet-Aktion-Plugin == |
|
134 |
+== Servlet-Aktions-Plugin == |
135 |
135 |
|
136 |
136 |
{{figure image="dbcounter_plugin_servlet_action.png"}} |
|
137 |
+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. |
137 |
137 |
{{/figure}} |
138 |
138 |
|
139 |
139 |
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: |
... |
... |
@@ -153,3
+153,28 @@ |
153 |
153 |
{{code}} |
154 |
154 |
https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID> |
155 |
155 |
{{/code}} |
|
157 |
+ |
|
158 |
+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: |
|
159 |
+ |
|
160 |
+; Status |
|
161 |
+: Gibt an, ob der Servlet-Aufruf erfolgreich war. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen: |
|
162 |
+:; Msg |
|
163 |
+:: Ein nummerischer Wert, der angibt, ob der Servlet-Aufruf erfolgreich war. Mögliche Werte sind: |
|
164 |
+::; (OK) |
|
165 |
+::; (NO_REQUEST_ID_ERROR) |
|
166 |
+::; (NO_COUNTER_TO_UUID_ERROR) |
|
167 |
+:; Code |
|
168 |
+:: Eine englische Beschreibung des Resultats (Erfolg oder Fehler). |
|
169 |
+; Counter |
|
170 |
+: Informationen zum angefragten Zähler. Der Wert ist ein weiteres JSON-Objekt mit folgenden Einträgen: |
|
171 |
+: Der aktuelle nummerische Wert des Zählers. |
|
172 |
+:; LastChange |
|
173 |
+:: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Das Datum wird mit dem Datums- und Zeitformat der aktuellen Server-Locale formattiert. |
|
174 |
+:; LastChangeTimestamp |
|
175 |
+:: Das Datum mit Uhrzeit, an dem der Zähler zuletzt geändert wurde. Der Zeitstempel ist eine ganze Zahl, welche die Anzahl an Millisekunden seit dem 1. Januar, 1970, 00:00:00 GMT angibt. |
|
176 |
+:; Value |
|
177 |
+:: Der aktuelle nummerische Wert des Zählers. |
|
178 |
+:; UUID |
|
179 |
+:: Die UUID des angefragten Zählers, dessen Wert ausgelesen wurde. |
|
180 |
+:; Name |
|
181 |
+:: Der Name des angefragten Zählers, dessen Wert ausgelesen wurde. |