Änderungen von Dokument Zähler


Von Version 3.6
bearbeitet von gru
am 30.08.2021, 12:35
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 3.9
bearbeitet von gru
am 30.08.2021, 13:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -52,3 +52,52 @@
52 52  
53 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 +
56 +== Zugriff auf Zählerwert per Servlet ==
57 +
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 +{{code language="none"}}
60 +<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&name=<Name des Zählers>
61 +<Serveradresse>/formcycle/form/clientcounter/?frid=<gültige FRID>&uuid=<UUID des Zählers>
62 +{{/code}}
63 +
64 +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.
65 +
66 +Eine bespielhafte JavaScript-Abfrage, welche den Zählerwert in das Feld //tf1// schreibt, könnte also wie folgt aussehen:
67 +
68 +{{code language="javascript"}}
69 +$.ajax({
70 + url:[
71 + XFC_METADATA.urls.counter_client,
72 + "?frid=",
73 + XFC_METADATA.currentSessionFRID,
74 + "&name=Beispielzähler"
75 + ].join(""),
76 + success: function(data, textStatus, jqXHR) {
77 + if (data.success) {
78 + $('[data-name="tf1"]').val(data.result.value);
79 + } else {
80 + console.error("Zugriff auf Zähler Beispielzähler fehlgeschlagen:",data.msg);
81 + }
82 + }
83 +});
84 +{{/code}}
85 +
86 +Neben dem eigentlichen Wert werden auch andere Informationen zurückgegeben. Die Antwort hat die folgende Struktur:
87 +; success
88 +: Boolscher Wert, der aussagt, ob die Werte gesetzt wurden.
89 +; msg
90 +: Servernachricht bezüglich der Anfrage, welche zur Fehlersuche verwendet werden kann. Ein erfolgreicher Zugriff liefert z.B. //Counter found//.
91 +; result
92 +: Antwort auf die Anfrage. Wenn die anfrage erfolgreich war, sind die folgenden Unterpunkte enthalten:
93 +:; lastChange
94 +:: Formatierte Ausgabe von Datum und Uhrzeit der letzten Änderung des Zählerwertes
95 +:; lastChangeTimestamp
96 +:: Epoche der letzten Änderung des Zählerwertes
97 +:; name
98 +:: Name des Zählers
99 +:; uuid
100 +:: UUID des Zählers
101 +:; value
102 +:: Aktueller Zählerwert
103 +