Changes for page Platzhalter

From version 36.1
edited by nlo
on 14.10.2021, 16:40
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.nlo
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,7 +51,7 @@
51 51  
52 52  === System variables ===
53 53  
54 -{{id name="system" /}}
70 +{{id name="system"/}}
55 55  
56 56  {{panel monospace="true" title="Syntax"}}
57 57  [%$<Name>%]
... ... @@ -61,10 +61,10 @@
61 61  
62 62  ; [%$CLIENT_ID%]
63 63  : The client ID of the client of the current form.
64 -; [%$CLIENT_MAIL_SENDER%] {{version major="7" minor="0" patch="4" /}}
65 -: Returns the mail sender address of the client. If none has been set then an empty string will be returned.
66 -; [%$CLIENT_MAIL_SENDERNAME%] {{version major="7" minor="0" patch="4" /}}
67 -: Returns the mail sender name of the client. If none has been set then an empty string will be returned.
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.
68 68  ; [%$FORM_LINK%]
69 69  : The URL of the current form.
70 70  ; [%$FORM_PROCESS_LINK%]
... ... @@ -77,6 +77,8 @@
77 77  : Returns the inbox link the form record currently resides in.
78 78  ; [%$FORM_INVITE_LINK%]
79 79  : 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.
80 80  ; [%$PROCESS_ID%]
81 81  : The current process ID of the form record.
82 82  ; [%$PROJECT_ALIAS%]
... ... @@ -139,8 +139,32 @@
139 139  {{/html}}
140 140  
141 141  
142 -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"]]).
143 143  
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 +
144 144  {{panel monospace="true" title="Syntax"}}
145 145  [%$&lt;user object&gt;.&lt;attribute&gt;%]
146 146  {{/panel}}
... ... @@ -147,7 +147,7 @@
147 147  
148 148  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.
149 149  
150 -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.
151 151  
152 152  
153 153  ==== User objects ====
... ... @@ -262,7 +262,7 @@
262 262  
263 263  === Action variables ===
264 264  
265 -{{id name="action" /}}
307 +{{id name="action"/}}
266 266  
267 267  {{panel monospace="true" title="Syntax"}}
268 268  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
... ... @@ -292,4 +292,3 @@
292 292  
293 293  ; [%$<actionName>.COUNT%]
294 294  : The number of results. Evaluates to an integer value.
295 -