Changes for page Platzhalter

From version 34.1
edited by jdr
on 22.07.2021, 17:46
Change comment: There is no comment for this version
To version 38.2
edited by gru
on 27.09.2023, 17:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.jdr
1 +XWiki.gru
Content
... ... @@ -1,6 +1,6 @@
1 1  {{content/}}
2 2  
3 -Variables are used to dynamically insert the value of form fields, the results of actions, certain system properties and more. They are available to [[templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], most settings of [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] and [[data base queries>>Formcycle.UserInterface.Data.DBQueries.WebHome]].
3 +Variables are used to dynamically insert the value of form fields, the results of actions, certain system properties and more. They are available to [[templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], most settings of [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] and [[data base queries>>Formcycle.UserInterface.Data.DBQueries]].
4 4  
5 5  As a common use case, consider a form allowing a user to enter their email address. When you would like to send an email to the address they entered, variables must be used.
6 6  
... ... @@ -40,6 +40,22 @@
40 40  
41 41  Example: The variable {{code language="none"}}[%tfEmail%]{{/code}} will take the value of the [[input field>>doc:Formcycle.Designer.Form.FormElements.Input]] named //tfEmail//.
42 42  
43 +=== Question element variables ===
44 +
45 +To access the values of [[select elements>>doc:Formcycle.Designer.Form.FormElements.Selection]] displayed as questions, you can use the following variables. Assume the select element is named //sel1//, has got 3 questions Q1, Q2, Q3 and 3 answers A1, A2, A3, and also assume these answers are selected:
46 +
47 +{{table}}
48 +|= - |= A1 |= A2 |= A3
49 +|Q1|☑|☐|☐
50 +|Q2|☑|☑|☐
51 +|Q3|☑|☑|☑
52 +{{/table}}
53 +
54 +Then:
55 +
56 +* //[%sel1%]// resolves to //A1;A1,A2;A1,A2,A3//
57 +* //[%sel1_0%]// resolves to //A1//, //[%sel1_1%]// resolves to //A1,A2//, and //[%sel1_2%]// resolves to //A1,A2,A3//
58 +
43 43  === Special form elements ===
44 44  
45 45  There are some special variables available:
... ... @@ -51,6 +51,8 @@
51 51  
52 52  === System variables ===
53 53  
70 +{{id name="system"/}}
71 +
54 54  {{panel monospace="true" title="Syntax"}}
55 55  [%$<Name>%]
56 56  {{/panel}}
... ... @@ -59,6 +59,10 @@
59 59  
60 60  ; [%$CLIENT_ID%]
61 61  : The client ID of the client of the current form.
80 +; [%$DEFAULT_MAIL_SENDER%] {{version major="7" minor="3"}}{{/version}}
81 +: Returns the e-mail sender (system) for the configured mail server. If a separate mail server is configured under Client > Settings, these configuration will be used, otherwise the system e-mail server.
82 +; [%$DEFAULT_MAIL_SENDERNAME%] {{version major="7" minor="3"}}{{/version}}
83 +: Returns the sender name (system) for the configured mail server. If this is not configured, an empty string is returned.
62 62  ; [%$FORM_LINK%]
63 63  : The URL of the current form.
64 64  ; [%$FORM_PROCESS_LINK%]
... ... @@ -71,6 +71,8 @@
71 71  : Returns the inbox link the form record currently resides in.
72 72  ; [%$FORM_INVITE_LINK%]
73 73  : Returns the invitation link of the form.
96 +; [%$FORM_HISTORY_HTML%] {{version major="7" minor="2" patch="0"/}}
97 +: Returns the the history of a form record as (HTML) table.
74 74  ; [%$PROCESS_ID%]
75 75  : The current process ID of the form record.
76 76  ; [%$PROJECT_ALIAS%]
... ... @@ -104,8 +104,8 @@
104 104  : The name of the task where the action of the event is located.
105 105  ; [%$TRIGGER.triggerName%]
106 106  : The name of the event where the action of the event is located.
107 -; [%$COUNTER_CLIENT.<counterName>%]
108 -: The current value of a client counter.
131 +; [%$COUNTER_CLIENT.<name of the counter>%]
132 +: The current value of a client [[counter>>doc:Formcycle.UserInterface.Data.Counter]].
109 109  
110 110  ==== System variables with parameters ====
111 111  
... ... @@ -133,8 +133,32 @@
133 133  {{/html}}
134 134  
135 135  
136 -User variables may be used in [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[data base queries>>Formcycle.UserInterface.Data.DBQueries.WebHome]] or directly in [[form elements>>Formcycle.Designer.Form.FormElements.WebHome]] for prefilling the form (see [[figure>>||anchor="fig_prefill_user_variables"]]).
137 137  
161 +{{html wiki="true"}}
162 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Using user variables to prefill form fields with data of the logged in user.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_en.png' width='300' group='$height' group='$group' title='Using user variables to prefill form fields with data of the logged in user.'/}}<div class='xm-figure-caption'>Using user variables to prefill form fields with data of the logged in user.</div></div></div>
163 +{{/html}}
164 +
165 +
166 +
167 +{{html wiki="true"}}
168 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Using user variables to prefill form fields with data of the logged in user.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_en.png' width='300' group='$height' group='$group' title='Using user variables to prefill form fields with data of the logged in user.'/}}<div class='xm-figure-caption'>Using user variables to prefill form fields with data of the logged in user.</div></div></div>
169 +{{/html}}
170 +
171 +
172 +
173 +{{html wiki="true"}}
174 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Using user variables to prefill form fields with data of the logged in user.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_en.png' width='300' group='$height' group='$group' title='Using user variables to prefill form fields with data of the logged in user.'/}}<div class='xm-figure-caption'>Using user variables to prefill form fields with data of the logged in user.</div></div></div>
175 +{{/html}}
176 +
177 +
178 +
179 +{{html wiki="true"}}
180 +<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Using user variables to prefill form fields with data of the logged in user.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='prefill_user_variables_en.png' width='300' group='$height' group='$group' title='Using user variables to prefill form fields with data of the logged in user.'/}}<div class='xm-figure-caption'>Using user variables to prefill form fields with data of the logged in user.</div></div></div>
181 +{{/html}}
182 +
183 +
184 +User variables may be used in [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]], [[templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[data base queries>>Formcycle.UserInterface.Data.DBQueries]] or directly in [[form elements>>Formcycle.Designer.Form.FormElements.WebHome]] for prefilling the form (see [[figure>>||anchor="fig_prefill_user_variables"]]).
185 +
138 138  {{panel monospace="true" title="Syntax"}}
139 139  [%$&lt;user object&gt;.&lt;attribute&gt;%]
140 140  {{/panel}}
... ... @@ -141,7 +141,7 @@
141 141  
142 142  There are three user objects available which can be used to access information about the user (user profile). If a user variable is being used without any attributes (e.g. [%$USER%]), all user information will be returned in [[JSON>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]] format.
143 143  
144 -For sensible use of the user variables it is necessary to enable [[form login>>doc:Formcycle.UserInterface.MyForms.Access.WebHome||anchor="form_login"]]. If this is not configured the user object will be set to an anonymous user.
192 +For sensible use of the user variables it is necessary to enable [[form login>>doc:Formcycle.UserInterface.MyForms.Access||anchor="form_login"]]. If this is not configured the user object will be set to an anonymous user.
145 145  
146 146  
147 147  ==== User objects ====
... ... @@ -256,6 +256,8 @@
256 256  
257 257  === Action variables ===
258 258  
307 +{{id name="action"/}}
308 +
259 259  {{panel monospace="true" title="Syntax"}}
260 260  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
261 261  {{/panel}}
... ... @@ -266,17 +266,21 @@
266 266  
267 267  ; [%$<actionName>.SUCCESS%]
268 268  : Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false.
269 -; [%$<actionName>.COUNT%]
270 -: This variable is not supported in the new workflow.
271 -: The number of results. Evaluates to an integer value.
272 272  ; [%$<actionName>.RESULT%]
273 273  : A single return value. Evaluates to a string value.
274 274  ; [%$<actionName>.RESULT[<Index>].<Identifier>%]
275 275  : Certain actions may return more than one result, corresponding to a //List<Map<String,String>>// in Java. The index and identifier is set by the corresponding action implementation and cannot be changed. This is used mostly by custom plugins when multiple values need to be returned.
276 276  
277 -These action variables are not supported in the old workflow:
324 +The following action variables are __not__ supported in the old workflow:
278 278  
279 279  ; [%$<actionName>.ERROR_CODE%]
280 280  : In case of error the thrown error code of the action.
281 281  ; [%$<actionName>.ERROR_MESSAGE%]
282 282  : In case of error the thrown error message of the action.
330 +
331 +In the new workflow, the number of elements of JSON arrays can be queried from variable values with //.length()//, e.g.: **[%$Database query.RESULT.rows.length()%]**
332 +
333 +The following action variable is __only__ supported in the old workflow:
334 +
335 +; [%$<actionName>.COUNT%]
336 +: The number of results. Evaluates to an integer value.