Änderungen von Dokument Zähler


Von Version 3.9
bearbeitet von gru
am 30.08.2021, 13:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 3.16
bearbeitet von gru
am 30.08.2021, 15:02
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -50,21 +50,47 @@
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 54  {{code language="none"}}[%$COUNTER_CLIENT.<Name des Zählers>%]{{/code}}
55 55  
56 56  == Zugriff auf Zählerwert per Servlet ==
57 57  
59 +=== Servlet-URL und Parameter ===
60 +
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 -{{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 63  
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 +
64 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 65  
66 -Eine bespielhafte JavaScript-Abfrage, welche den Zählerwert in das Feld //tf1// schreibt, könnte also wie folgt aussehen:
70 +=== ckgabewerte ===
67 67  
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 +
68 68  {{code language="javascript"}}
69 69  $.ajax({
70 70   url:[
... ... @@ -82,22 +82,3 @@
82 82   }
83 83  });
84 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 -