Changes for page Platzhalter


From version 32.1
edited by jdr
on 21.07.2021, 09:42
Change comment: There is no comment for this version
To version 37.1
edited by sas
on 16.02.2023, 14:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.jdr
1 +XWiki.sas
Content
... ... @@ -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="0" patch="4"/}}
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="0" patch="4"/}}
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%]
... ... @@ -78,6 +78,7 @@
78 78  ; [%$PROJECT_ID%]
79 79  : The form ID of the current form.
80 80  ; [%$PROJECT_TITLE%]
105 +: As of version 7, [%$PROJECT_NAME%] is now called [%$PROJECT_TITLE%] .
81 81  : The title of the current form.
82 82  ; [%$RECORD_ID%]
83 83  : The ID of the current form record.
... ... @@ -103,8 +103,8 @@
103 103  : The name of the task where the action of the event is located.
104 104  ; [%$TRIGGER.triggerName%]
105 105  : The name of the event where the action of the event is located.
106 -; [%$COUNTER_CLIENT.<counterName>%]
107 -: 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]].
108 108  
109 109  ==== System variables with parameters ====
110 110  
... ... @@ -132,6 +132,12 @@
132 132  {{/html}}
133 133  
134 134  
160 +
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 +
135 135  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"]]).
136 136  
137 137  {{panel monospace="true" title="Syntax"}}
... ... @@ -255,6 +255,8 @@
255 255  
256 256  === Action variables ===
257 257  
289 +{{id name="action"/}}
290 +
258 258  {{panel monospace="true" title="Syntax"}}
259 259  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
260 260  {{/panel}}
... ... @@ -265,14 +265,21 @@
265 265  
266 266  ; [%$<actionName>.SUCCESS%]
267 267  : Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false.
268 -; [%$<actionName>.COUNT%]
269 -: This variable is not supported in the new workflow.
270 -: The number of results. Evaluates to an integer value.
271 271  ; [%$<actionName>.RESULT%]
272 272  : A single return value. Evaluates to a string value.
273 273  ; [%$<actionName>.RESULT[<Index>].<Identifier>%]
274 274  : 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.
305 +
306 +The following action variables are __not__ supported in the old workflow:
307 +
275 275  ; [%$<actionName>.ERROR_CODE%]
276 276  : In case of error the thrown error code of the action.
277 277  ; [%$<actionName>.ERROR_MESSAGE%]
278 278  : In case of error the thrown error message of the action.
312 +
313 +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()%]**
314 +
315 +The following action variable is __only__ supported in the old workflow:
316 +
317 +; [%$<actionName>.COUNT%]
318 +: The number of results. Evaluates to an integer value.