Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -131,5 +131,50 @@
131	131	[%$DBCOUNTER.test%]
132	132	{{/code}}
133	133
134		-== Servlet-Aktion-Plugin ==
	134	+== Servlet-Aktions-Plugin ==
135	135
	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.
	138	+{{/figure}}
	139	+
	140	+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:
	141	+
	142	+{{code}}
	143	+https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&client-id=<MANDANT_ID>&id=<ZAEHLER_UUID>
	144	+{{/code}}
	145	+
	146	+Falls also etwa FORMCYCLE lokal unter dem Pfad //xima-formcycle// installiert wurde, der Zähler in einem Projekt des Mandanten mit der ID //1// verwendet wird und die UUID //bc49d3b0-f869-4e59-864e-ddcc2925ed63// besitzt, dann lautet die URL:
	147	+
	148	+{{code}}
	149	+https://localhost:8080/xima-formcycle/plugin?name=Servlet%20Counter&client-id=1&id=bc49d3b0-f869-4e59-864e-ddcc2925ed63
	150	+{{/code}}
	151	+
	152	+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:
	153	+
	154	+{{code}}
	155	+https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID>
	156	+{{/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	+: Der aktuelle nummerische Wert des Zählers.
	171	+:; LastChange
	172	+:: 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.
	173	+:; LastChangeTimestamp
	174	+:: 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.
	175	+:; Value
	176	+:: Der aktuelle nummerische Wert des Zählers.
	177	+:; UUID
	178	+:: Die UUID des angegeben Zählers, dessen Wert ausgelesen wurde.
	179	+:; Name
	180	+:: Der Name des angegeben Zählers, dessen Wert ausgelesen wurde.