| ... |
... |
@@ -56,13 +56,17 @@ |
| 56 |
56 |
|
| 57 |
57 |
=== Verwendung von Platzhaltern im Formular === |
| 58 |
58 |
|
| 59 |
|
-{{figure image="5_Beispiel_Zahlfeld.png" width="600"}} |
|
59 |
+{{figure image="6_Beispiel_Zahlfeld.png" width="600"}} |
| 60 |
60 |
Weiteres Eingabefeld zum Anzeigen der Anzahl der noch verfügbaren Plätze und die dafür nötigen Einstellungen im {{designer/}}. |
| 61 |
61 |
{{/figure}} |
| 62 |
62 |
|
|
63 |
+{{figure image="7_Beispiel_Button.png" width="600" clear="h3"}} |
|
64 |
+Konfiguration der Scihtbarkeitsbedingung der Schaltfläche zum Absenden im {{designer/}}. |
|
65 |
+{{/figure}} |
|
66 |
+ |
| 63 |
63 |
Um dem Benutzer beim Öffnen des Formulars die Anzahl der zu diesem Zeitpunkt noch verfügbaren Plätze anzuzeigen, kann ein weiteres Eingabefeld verwendet. Dieses wird so Konfiguriert, dass es vom Benutzer nicht editiert werden kann und über den Platzhalter {{code language="none"}}[%$$DBCOUNTER.BeispielZaehler%]{{/code}} beim Aufruf des Formulars mit dem aktuellen Zählerwert befüllt wird. |
| 64 |
64 |
|
| 65 |
|
-Um zu verhindern, dass das Formular abgesendet werden kann, wenn es keine freien Plätze mehr gibt, kann im {{designer/}} für die Schaltfläche zum Absenden eine //Verstecken wenn//-Bedingung konfiguriert werden, welche das die Schaltfläche unsichtbar macht, wenn das der Wert im gerade angelegten Eingabeelement (und damit der Wert des Zähler) 0 ist. |
|
69 |
+Um zu verhindern, dass das Formular abgesendet werden kann, wenn es keine freien Plätze mehr gibt, kann im {{designer/}} für die Schaltfläche zum Absenden eine //Verstecken wenn//-Bedingung konfiguriert werden. Über diese wird die Schaltfläche unsichtbar, wenn das der Wert im gerade angelegten Eingabeelement (und damit der Wert des Zähler) 0 ist. |
| 66 |
66 |
|
| 67 |
67 |
{{velocity}} |
| 68 |
68 |
##=== Auslesen des Zählerwertes per JavaScript === |
| ... |
... |
@@ -71,42 +71,33 @@ |
| 71 |
71 |
{{/velocity}} |
| 72 |
72 |
=== Herunterladen des Beispielformulars === |
| 73 |
73 |
|
| 74 |
|
-Das Formular mit allen gemachten Einstellungen kann **HIER** heruntergeladen werden. Damit das Formular funktioniert, muss jedoch ein eigener Zähler unter [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] angelegt werden und dieser muss in der Aktion //Counter// ausgewählt werden. |
|
78 |
+Das Formular mit allen gemachten Einstellungen kann **[[hier>>attach:Beispiel Zähler.zip]]** heruntergeladen werden. Damit das Formular funktioniert, muss jedoch ein eigener Zähler unter [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] angelegt werden und dieser muss in der Aktion //Counter// ausgewählt werden. Beim Import des Formulars kann außerdem ein HTML-Template mit importiert werden, welches dem Absender eines Formulars mittteilt, dass es keine weiteren freien Plätze gibt. |
| 75 |
75 |
|
| 76 |
76 |
== Einstellungen im Menüpunkt "Zählerkonfiguration" == |
| 77 |
77 |
|
| 78 |
|
-{{figure image="6_plugin_dbcounter_config_base_de.png" width="600"}} |
| 79 |
|
-Das Menü mit einer Übersicht über alle vorhandenen Zähler. Hier können auch neue Zähler hinzugefügt und bestehende {{/figure}} |
|
82 |
+{{figure image="8_plugin_dbcounter_config_base_de.png" width="600"}} |
|
83 |
+Das Menü mit einer Übersicht über alle vorhandenen Zähler. Hier können auch neue Zähler hinzugefügt und bestehende Zähler bearbeitet werden.{{/figure}} |
| 80 |
80 |
|
| 81 |
81 |
Nach Installation des Datenbankzähler-Plugin-Bundle erscheint links im Hauptmenü ein neuer Menüeintrag mit dem Namen //Zählerkonfiguration//. In diesem Menü findet sich eine Übersicht mit Informationen über alle vorhandenen Zähler, etwa deren Namen und aktuellen Wert. Weiterhin ist es auch möglich, neue Zähler anzulegen oder bestehende Zähler zu bearbeiten und zu löschen. |
| 82 |
82 |
|
| 83 |
83 |
Ein neuer Zähler wird durch Drücken auf das Plus-Symbol links oben angelegt. Ein bestehender Zähler wird Betätigen des Papierkorb-Symbols links oben gelöscht. |
| 84 |
84 |
|
| 85 |
|
-=== Eigenschaften === |
|
89 |
+=== Zählerdaten === |
| 86 |
86 |
|
| 87 |
87 |
In der Liste links kann ein Zähler ausgewählt werden. Nach Auswahl erscheinen die folgenden Informationen zum ausgewählten Zähler: |
| 88 |
88 |
|
| 89 |
|
-; {{smallcaps}}Uuid{{/smallcaps}} |
| 90 |
|
-: Eine eindeutige {{smallcaps}}id{{/smallcaps}} des Zählers, die etwa beim Abruf des Zählerwerts per {{smallcaps}}Ajax{{/smallcaps}} (siehe Servlet-Aktions-Plugin unten) verwendet wird. |
| 91 |
|
-; Aktueller Wert |
| 92 |
|
-: Der aktuelle Wert des Zählers. |
| 93 |
|
-; Erstellt am |
| 94 |
|
-: Das Datum, an dem der Zähler erstellt wurde. |
| 95 |
|
-; Geändert am |
| 96 |
|
-: Das Datum, an dem der Wert des Zählers zuletzt geändert wurde. |
| 97 |
|
- |
| 98 |
98 |
Weiterhin können die folgenden Eigenschaften des Zählers bearbeitet werden: |
| 99 |
99 |
|
| 100 |
100 |
; Zählername |
| 101 |
101 |
: Der Name dieses Zählers. Wird der Name geändert, sollte beachtet werden, dass Platzhalter und {{smallcaps}}Ajax{{/smallcaps}}-Abfragen, wo der Name des Zählers verwendet wird, ebenfalls angepasst werden müssen. {{smallcaps}}Ajax{{/smallcaps}}-Abfrage bei denen die {{smallcaps}}Uuid{{/smallcaps}} des Zählers verwendet wird müssen hingegen nicht angepasst werden, da die {{smallcaps}}Uuid{{/smallcaps}} des Zählers sich nicht ändert. |
|
97 |
+; Aktueller Wert |
|
98 |
+: Der aktuelle Wert des Zählers. Kann über die //Stift//-Schaltfläche bearbeitet werden. |
| 102 |
102 |
; Beschreibung |
| 103 |
103 |
: Eine optionale Beschreibung des Zählers, die auch nur in diesem Backend-Menü einsehbar ist. |
| 104 |
|
-; Startwert |
| 105 |
|
-: Der Startwert des Zählers. Dieser wird auch benutzt, wenn in einer Aktion der Zählerwert auf den Startwert zurückgesetzt werden soll. |
| 106 |
106 |
; Automatisch zurücksetzen |
| 107 |
107 |
: Wenn diese Option aktiviert ist, wird der Zähler in periodischen Abständen auf den Startwert zurückgesetzt. |
| 108 |
108 |
|
| 109 |
|
-=== Automatisches Zurücksetzen === |
|
104 |
+==== Automatisches Zurücksetzen ==== |
| 110 |
110 |
|
| 111 |
111 |
Folgende Eigenschaften erscheinen, wenn die Option //Automatisch Zurücksetzen// ausgewählt wurde: |
| 112 |
112 |
|
| ... |
... |
@@ -133,6 +133,21 @@ |
| 133 |
133 |
:; jährlich |
| 134 |
134 |
:: Der Zähler wird jedes Jahr zum gewählten Tag zu der gewählten Uhrzeit zurückgesetzt |
| 135 |
135 |
|
|
131 |
+=== Zähler-Metadaten === |
|
132 |
+ |
|
133 |
+In diesem Bereich werden Meta-Informationen zum aktuell ausgewählten Zähler ausgegeben. |
|
134 |
+ |
|
135 |
+; {{smallcaps}}Uuid{{/smallcaps}} |
|
136 |
+: Eine eindeutige {{smallcaps}}id{{/smallcaps}} des Zählers, die etwa beim Abruf des Zählerwerts per {{smallcaps}}Ajax{{/smallcaps}} (siehe Servlet-Aktions-Plugin unten) verwendet wird. |
|
137 |
+; Angelegt am |
|
138 |
+: Das Datum, an dem der Zähler erstellt wurde. |
|
139 |
+; Geändert am |
|
140 |
+: Das Datum, an dem der Wert des Zählers zuletzt geändert wurde. |
|
141 |
+ |
|
142 |
+=== Zähler-Zugriffmöglichkeiten === |
|
143 |
+ |
|
144 |
+Hier wir eine {{smallcaps}}Url{{/smallcaps}} für den direkten Zugriff auf den Zählerwert per AJAX-Request angegeben und ein JavaScript-Template für das Ausführen eines solchen AJAX-Requests innerhalb eines Formulars bereitgestellt. Bei dem JavaScript-Code ist zu beachten, dass dieser die jQuery-Funktion {{code language="none"}}$.ajax(){{/code}} verwendet, welche noch um Funktionen für das Behandeln von des zurückgegebenen Wertes ergänzt werden muss (z.B. Funktion über das Hinzufügen einer //success//-Funktion). |
|
145 |
+ |
| 136 |
136 |
== Aktionsverarbeitung "Counter" == |
| 137 |
137 |
|
| 138 |
138 |
{{figure image="7_plugin_dbcounter_action_counter_de.png"}} |
| ... |
... |
@@ -143,6 +143,8 @@ |
| 143 |
143 |
|
| 144 |
144 |
Im der Aktion muss der Zähler fest ausgewählt werden und muss daher zuvor in der [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] (siehe oben) angelegt werden. |
| 145 |
145 |
|
|
156 |
+=== Parameter der Aktion === |
|
157 |
+ |
| 146 |
146 |
; Zählername |
| 147 |
147 |
: Auswahl des Zählers, dessen Wert geändert werden soll. Der Zähler muss vorher in der Zählerkonfiguration angelegt werden. Für jeden Zähler wird sowohl sein Name als auch seine {{smallcaps}}Uuid{{/smallcaps}} angezeigt. Die {{smallcaps}}Uuid{{/smallcaps}} dient der eindeutigen Identifikation des Zählers und wird etwa bei der Abfrage per {{smallcaps}}Ajax{{/smallcaps}} verwendet. |
| 148 |
148 |
|
| ... |
... |
@@ -157,14 +157,10 @@ |
| 157 |
157 |
; Schrittweite |
| 158 |
158 |
: Anzahl, um die der Zähler hoch beziehungsweise herunter gesetzt werden soll. Nicht verfügbar, wenn //Zähler auf Startwert zurücksetzen// ausgewählt wurde. |
| 159 |
159 |
|
| 160 |
|
-== Rückgabeparameter der Aktionen == |
|
172 |
+=== Rückgabeparameter der Aktion === |
| 161 |
161 |
|
| 162 |
|
-{{figure image="plugin_dbcounter_action_return_parameters_de.png"}} |
| 163 |
|
-Einstellungen für die Rückgabeparameter der Aktion, die später über Aktionsplatzhalter verfügbar sind. |
| 164 |
|
-{{/figure}} |
|
174 |
+Manchmal ist es notwendig, auf das Ergebnis der Zählaktion zugreifen zu können, wie zum Beispiel 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].Counter%]// auf den aktuellen Zählwert zugegriffen werden. Folgende Rückgabeparameter sind verfügbar: |
| 165 |
165 |
|
| 166 |
|
-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].Counter%]// auf den aktuellen Zählwert zugegriffen werden. Folgende Rückgabeparameter sind verfügbar: |
| 167 |
|
- |
| 168 |
168 |
; ResultCode |
| 169 |
169 |
: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich: |
| 170 |
170 |
:; 1 (OK) |
| ... |
... |
@@ -203,21 +203,17 @@ |
| 203 |
203 |
{{/code}} |
| 204 |
204 |
|
| 205 |
205 |
{{info}} |
| 206 |
|
-Bis einschließlich der Version 3.0.0 des Datenbankzähler-Plugins wurden Platzhalter nur über ein Systemplatzhalter-Plugin bereitgestellt und folgten damit dem Schema {{code language="none"}}[%$DBCOUNTER.<Zählername>%]{{/code}}. Diese werden in einer zukünftigen Version des Datenbankzähler-Plugins nicht mehr unterstützt. |
|
214 |
+Bis einschließlich der Version 3.0.0 des Datenbankzähler-Plugins wurden Platzhalter nur über ein Systemplatzhalter-Plugin bereitgestellt und folgten damit dem Schema {{code language="none"}}[%$DBCOUNTER.<Zählername>%]{{/code}}. Diese werden in einer zukünftigen Version des Datenbankzähler-Plugins nicht weiter unterstützt. |
| 207 |
207 |
{{/info}} |
| 208 |
208 |
|
| 209 |
|
-== Servlet-Aktions-Plugin == |
|
217 |
+== Servlet-Aktions-Plugin / Zugriff auf Zählerwert mittels AJAX-Reques== |
| 210 |
210 |
|
| 211 |
211 |
{{figure image="dbcounter_plugin_servlet_action.png"}} |
| 212 |
212 |
Beispiel zum Auslesen eines Zählers im Formular mittels {{smallcaps}}Ajax{{/smallcaps}}. Die {{smallcaps}}Url{{/smallcaps}} wird anhand der im Formular zur Verfügung stehenden Metadaten aufgebaut. Hiermit wird vermieden, die {{smallcaps}}Url{{/smallcaps}} hart im Quelltext zu hinterlegen, was zu Fehlern führt, wenn sich etwa der Server oder der Kontextpfad ändern sollte. |
| 213 |
213 |
{{/figure}} |
| 214 |
214 |
|
| 215 |
|
-Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies kann dazu genutzt werden, um aus einem Formular den Wert eines Zählers per {{smallcaps}}Ajax{{/smallcaps}}-Anfrage zu ermitteln. |
|
223 |
+Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies kann dazu genutzt werden, um aus einem Formular den Wert eines Zählers per {{smallcaps}}Ajax{{/smallcaps}}-Anfrage zu ermitteln. In der [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] wird eine Vorlage für einen {{smallcaps}}Ajax{{/smallcaps}}-Zugriff auf den jeweiligen Zähler bereitgestellt. |
| 216 |
216 |
|
| 217 |
|
-== Zugriff auf Zählerwert mittels AJAX-Request == |
| 218 |
|
- |
| 219 |
|
-In der [[//Zählerkonfiguration>>||anchor="HEinstellungenimMenFCpunkt22ZE4hlerkonfiguration22"]] wird eine Vorlage für einen {{smallcaps}}Ajax{{/smallcaps}}-Zugriff auf den jeweiligen Zähler bereitgestellt. |
| 220 |
|
- |
| 221 |
221 |
Gernerell muss für einen Zugriff auf den Wert eines Zählers per AJAX eine entsprechende {{smallcaps}}Url{{/smallcaps}} verwendet werden. Diese folgt dem folgenden Schema: |
| 222 |
222 |
|
| 223 |
223 |
{{code language="none"}} |
