Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
  • plugin_dbcounter_action_return_parameters_en.png

Details

Seiteneigenschaften

Inhalt

...	...	@@ -43,13 +43,13 @@
43	43
44	44	== Rückgabeparameter der Aktionen ==
45	45
46		-{{figure image="dbcounter_plugin_action_return_parameters_de.png"}}
47		-Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind.
	46	+{{figure image="plugin_dbcounter_action_return_parameters_de.png"}}
	47	+Einstellungen für die Rückgabeparameter der Aktion, die später über Aktionsplatzhalter verfügbar sind.
48	48	{{/figure}}
49	49
50		-Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. Dies kann über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables]] 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:
	50	+Manchmal ist es notwendig, auf das Ergebnis der Zählaktion zugreifen zu können, etwa den aktuellen Wert oder den Statuscode. Dies kann über [[Aktionsplatzhalter>>doc:Formcycle.UserInterface.Variables]] geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel auf die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].currentValue%]// auf den aktuellen Zählwert zugegriffen werden, falls unter bei den allgemeinen Rückgabeparameter der Wert //currentValue// im mittleren Eingabefelder //Counter// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar:
51	51
52		-; 1 - ResultCode
	52	+; ResultCode
53	53	: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich:
54	54	:; 1 (OK)
55	55	:: Die Zählaktion wurde erfolgreich abgearbeitet.
...	...	@@ -59,13 +59,13 @@
59	59	:: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde.
60	60	:; 40 (INTERNAL_ERROR)
61	61	:: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann.
62		-; 2 - ResultMessage
	62	+; ResultMessage
63	63	: Eine englische Beschreibung des Resultats (Erfolg oder Fehler).
64		-; 3 - Counter
	64	+; Counter
65	65	: Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde.
66		-; 4 - IsReset
	66	+; IsReset
67	67	: Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde.
68		-; 5 - CounterAfterReset
	68	+; CounterAfterReset
69	69	: Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen.
70	70
71	71	== Systemplatzhalter-Plugin ==
...	...	@@ -80,12 +80,24 @@
80	80	[%$DBCOUNTER.<Zählername>%]
81	81	{{/code}}
82	82
83		-Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
	83	+Um also etwa auf den Zähler mit dem Namen //test// zuzugreifen, muss der folgende Platzhalter genutzt werden:
84	84
85	85	{{code}}
86	86	[%$DBCOUNTER.test%]
87	87	{{/code}}
88	88
	89	+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:
	90	+
	91	+{{code}}
	92	+[%$DBCOUNTER(<Zählername>, <Startwert>)%]
	93	+{{/code}}
	94	+
	95	+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:
	96	+
	97	+{{code}}
	98	+[%$DBCOUNTER(teilnehmer-2020-03-17, 0)%]
	99	+{{/code}}
	100	+
89	89	== Servlet-Aktions-Plugin ==
90	90
91	91	{{figure image="dbcounter_plugin_servlet_action.png"}}
...	...	@@ -95,7 +95,7 @@
95	95	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:
96	96
97	97	{{code}}
98		-https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&client-id=<MANDANT_ID>&id=<ZAEHLER_UUID>
	110	+https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID>
99	99	{{/code}}
100	100
101	101	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:
...	...	@@ -107,9 +107,25 @@
107	107	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:
108	108
109	109	{{code}}
110		-https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID>
	122	+https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID>
111	111	{{/code}}
112	112
	125	+=== HTTP-Parameter
	126	+
	127	+Zusätzlich zu den oben genannten Parametern gibt es noch weitere Parameter, die an die URL angehängt werden können. Im Folgenden werden alle verfügbaren Parameter kurz erläutert.
	128	+
	129	+; name: Pluginname ('Counter')
	130	+
	131	+project-id: Projekt-ID
	132	+
	133	+id oder counter-name: UUID oder Name des Counters. Wird eine UUID angegeben und existiert der Counter noch nicht, wird ein entsprechender Fehler-Code zurückgeliefert. Wird ein Name angegeben und existiert der Counter noch nicht, wird ein neuer Counter erstellt.
	134	+
	135	+counter-initial: Initialer Wert des Counters, wenn dieser noch nicht existiert (nur wenn counter-name benutzt wird).
	136	+
	137	+counter-array: Liefert statt einem JSON-Objekt ein Array zurück. Hier können mehrere Namen oder UUID übergeben werden.
	138	+
	139	+=== HTTP-Antwort
	140	+
113	113	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:
114	114
115	115	; Status

plugin_dbcounter_action_return_parameters_en.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.awa

Größe

...	...	@@ -1,0 +1,1 @@
	1	+59.9 KB

Inhalt