... |
... |
@@ -50,47 +50,19 @@ |
50 |
50 |
|
51 |
51 |
== Platzhalter == |
52 |
52 |
|
53 |
|
-Die Werte von Zählern können über [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] zum Beispiel im Workflow oder als Wert von Formularelementen ausgelesen werden. Die Syntax ist dabei wie folgt: |
54 |
|
- |
|
53 |
+Die Werte von Zählern können über [[Platzhalter:doc>>Formcycle.UserInterface.Variables]] zum Beispiel im Workflow oder als Wert von Formularelementen ausgelesen werden. Die Syntax ist dabei wie folgt: |
55 |
55 |
{{code language="none"}}[%$COUNTER_CLIENT.<Name des Zählers>%]{{/code}} |
56 |
56 |
|
57 |
57 |
== Zugriff auf Zählerwert per Servlet == |
58 |
58 |
|
59 |
|
-=== Servlet-URL und Parameter === |
60 |
|
- |
61 |
61 |
Der Wert der Zähler kann innerhalb von Formularen über einen Servletaufruf ermittelt werden. Es ist dabei möglich, den Zähler über seinen Namen oder seine UUID auszuwählen. Die entsprechenden {{smallcaps}}URL{{/smallcaps}}s zum Aufruf der Werte könnten zum Beispiel wie folgt aussehen: |
|
59 |
+{{code language="none"}}<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&name=<Name des Zählers> |
|
60 |
+<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&uuid=<UUID des Zählers>{{/code}} |
62 |
62 |
|
63 |
|
-{{code language="none"}}https://<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&name=<Name des Zählers>{{/code}} |
64 |
|
-und |
65 |
|
-{{code language="none"}}https://<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&uuid=<UUID des Zählers>{{/code}} |
66 |
|
- |
67 |
|
- |
68 |
68 |
In beiden Fällen wird eine gültige //form request id// (frid) benötigt, welche im Formular per JavaScript unter {{code language="none"}}XFC_METADATA.currentSessionFRID{{/code}} zu finden ist. Auf gleiche Art kann zudem die {{smallcaps}}URL{{/smallcaps}} des Servlets per JavaScript unter {{code language="none"}}XFC_METADATA.urls.counter_client{{/code}} ausgelesen werden. Dies ist wichtig, da sich die {{smallcaps}}URL{{/smallcaps}} bei Aufrufen über Frontend- und Masterserver unterscheidet. |
69 |
69 |
|
70 |
|
-=== Rückgabewerte === |
|
64 |
+Eine bespielhafte JavaScript-Abfrage, welche den Zählerwert in das Feld //tf1// schreibt, könnte also wie folgt aussehen: |
71 |
71 |
|
72 |
|
-Das Erebnis wird als JSON zurückgegeben. Neben dem eigentlichen Wert sind auch andere Informationen zurückgegeben. Die Antwort hat die folgende Struktur: |
73 |
|
-; success |
74 |
|
-: Boolscher Wert, der aussagt, ob der Zählerwert erfolgreich ausgelesen werden konnte. |
75 |
|
-; msg |
76 |
|
-: Servernachricht bezüglich der Anfrage, welche zur Fehlersuche verwendet werden kann. Ein erfolgreicher Zugriff liefert z.B. //Counter found//. |
77 |
|
-; result |
78 |
|
-: Antwort auf die Anfrage. Wenn die Anfrage erfolgreich war, sind die folgenden Unterpunkte enthalten: |
79 |
|
-:; lastChange |
80 |
|
-:: Formatierte Ausgabe von Datum und Uhrzeit der letzten Änderung des Zählerwertes |
81 |
|
-:; lastChangeTimestamp |
82 |
|
-:: Epoche der letzten Änderung des Zählerwertes |
83 |
|
-:; name |
84 |
|
-:: Name des Zählers |
85 |
|
-:; uuid |
86 |
|
-:: UUID des Zählers |
87 |
|
-:; value |
88 |
|
-:: Aktueller Zählerwert |
89 |
|
- |
90 |
|
-=== Beispiel für eine AJAX-Anfrage im Formular === |
91 |
|
- |
92 |
|
-Eine bespielhafte AJAX-Anfrage, welche den aktuellen Zählerwert des Zählers //Beispielzähler// in das Feld //tf1// schreibt, könnte also wie folgt aussehen: |
93 |
|
- |
94 |
94 |
{{code language="javascript"}} |
95 |
95 |
$.ajax({ |
96 |
96 |
url:[ |
... |
... |
@@ -108,3 +108,22 @@ |
108 |
108 |
} |
109 |
109 |
}); |
110 |
110 |
{{/code}} |
|
83 |
+ |
|
84 |
+Neben dem eigentlichen Wert werden auch andere Informationen zurückgegeben. Die Antwort hat die folgende Struktur: |
|
85 |
+; success |
|
86 |
+: Boolscher Wert, der aussagt, ob die Werte gesetzt wurden. |
|
87 |
+; msg |
|
88 |
+: Servernachricht bezüglich der Anfrage, welche zur Fehlersuche verwendet werden kann. Ein erfolgreicher Zugriff liefert z.B. //Counter found//. |
|
89 |
+; result |
|
90 |
+: Antwort auf die Anfrage. Wenn die anfrage erfolgreich war, sind die folgenden Unterpunkte enthalten: |
|
91 |
+:; lastChange |
|
92 |
+:: Formatierte Ausgabe von Datum und Uhrzeit der letzten Änderung des Zählerwertes |
|
93 |
+:; lastChangeTimestamp |
|
94 |
+:: Epoche der letzten Änderung des Zählerwertes |
|
95 |
+:; name |
|
96 |
+:: Name des Zählers |
|
97 |
+:; uuid |
|
98 |
+:: UUID des Zählers |
|
99 |
+:; value |
|
100 |
+:: Aktueller Zählerwert |
|
101 |
+ |