... |
... |
@@ -50,11 +50,13 @@ |
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: |
|
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 |
54 |
{{code language="none"}}[%$COUNTER_CLIENT.<Name des Zählers>%]{{/code}} |
55 |
55 |
|
56 |
56 |
== Zugriff auf Zählerwert per Servlet == |
57 |
57 |
|
|
58 |
+=== Servlet-URL und Parameter === |
|
59 |
+ |
58 |
58 |
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 |
59 |
|
60 |
60 |
{{code language="none"}}<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&name=<Name des Zählers>{{/code}} |
... |
... |
@@ -64,26 +64,8 @@ |
64 |
64 |
|
65 |
65 |
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. |
66 |
66 |
|
67 |
|
-Eine bespielhafte JavaScript-Abfrage, welche den Zählerwert in das Feld //tf1// schreibt, könnte also wie folgt aussehen: |
|
69 |
+=== Rückgabewerte === |
68 |
68 |
|
69 |
|
-{{code language="javascript"}} |
70 |
|
-$.ajax({ |
71 |
|
- url:[ |
72 |
|
- XFC_METADATA.urls.counter_client, |
73 |
|
- "?frid=", |
74 |
|
- XFC_METADATA.currentSessionFRID, |
75 |
|
- "&name=Beispielzähler" |
76 |
|
- ].join(""), |
77 |
|
- success: function(data, textStatus, jqXHR) { |
78 |
|
- if (data.success) { |
79 |
|
- $('[data-name="tf1"]').val(data.result.value); |
80 |
|
- } else { |
81 |
|
- console.error("Zugriff auf Zähler Beispielzähler fehlgeschlagen:",data.msg); |
82 |
|
- } |
83 |
|
- } |
84 |
|
-}); |
85 |
|
-{{/code}} |
86 |
|
- |
87 |
87 |
Neben dem eigentlichen Wert werden auch andere Informationen zurückgegeben. Die Antwort hat die folgende Struktur: |
88 |
88 |
; success |
89 |
89 |
: Boolscher Wert, der aussagt, ob die Werte gesetzt wurden. |
... |
... |
@@ -102,3 +102,24 @@ |
102 |
102 |
:; value |
103 |
103 |
:: Aktueller Zählerwert |
104 |
104 |
|
|
89 |
+=== Beispiel für eine AJAX-Anfrage im Formular === |
|
90 |
+ |
|
91 |
+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: |
|
92 |
+ |
|
93 |
+{{code language="javascript"}} |
|
94 |
+$.ajax({ |
|
95 |
+ url:[ |
|
96 |
+ XFC_METADATA.urls.counter_client, |
|
97 |
+ "?frid=", |
|
98 |
+ XFC_METADATA.currentSessionFRID, |
|
99 |
+ "&name=Beispielzähler" |
|
100 |
+ ].join(""), |
|
101 |
+ success: function(data, textStatus, jqXHR) { |
|
102 |
+ if (data.success) { |
|
103 |
+ $('[data-name="tf1"]').val(data.result.value); |
|
104 |
+ } else { |
|
105 |
+ console.error("Zugriff auf Zähler Beispielzähler fehlgeschlagen:",data.msg); |
|
106 |
+ } |
|
107 |
+ } |
|
108 |
+}); |
|
109 |
+{{/code}} |