... |
... |
@@ -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]]. |
|
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]]. |
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,22 +40,6 @@ |
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 |
|
- |
59 |
59 |
=== Special form elements === |
60 |
60 |
|
61 |
61 |
There are some special variables available: |
... |
... |
@@ -67,8 +67,6 @@ |
67 |
67 |
|
68 |
68 |
=== System variables === |
69 |
69 |
|
70 |
|
-{{id name="system"/}} |
71 |
|
- |
72 |
72 |
{{panel monospace="true" title="Syntax"}} |
73 |
73 |
[%$<Name>%] |
74 |
74 |
{{/panel}} |
... |
... |
@@ -77,10 +77,6 @@ |
77 |
77 |
|
78 |
78 |
; [%$CLIENT_ID%] |
79 |
79 |
: 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. |
84 |
84 |
; [%$FORM_LINK%] |
85 |
85 |
: The URL of the current form. |
86 |
86 |
; [%$FORM_PROCESS_LINK%] |
... |
... |
@@ -93,8 +93,6 @@ |
93 |
93 |
: Returns the inbox link the form record currently resides in. |
94 |
94 |
; [%$FORM_INVITE_LINK%] |
95 |
95 |
: 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. |
98 |
98 |
; [%$PROCESS_ID%] |
99 |
99 |
: The current process ID of the form record. |
100 |
100 |
; [%$PROJECT_ALIAS%] |
... |
... |
@@ -157,32 +157,8 @@ |
157 |
157 |
{{/html}} |
158 |
158 |
|
159 |
159 |
|
|
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"]]). |
160 |
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 |
|
- |
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 |
|
- |
186 |
186 |
{{panel monospace="true" title="Syntax"}} |
187 |
187 |
[%$<user object>.<attribute>%] |
188 |
188 |
{{/panel}} |
... |
... |
@@ -189,7 +189,7 @@ |
189 |
189 |
|
190 |
190 |
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. |
191 |
191 |
|
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. |
|
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. |
193 |
193 |
|
194 |
194 |
|
195 |
195 |
==== User objects ==== |
... |
... |
@@ -304,8 +304,6 @@ |
304 |
304 |
|
305 |
305 |
=== Action variables === |
306 |
306 |
|
307 |
|
-{{id name="action"/}} |
308 |
|
- |
309 |
309 |
{{panel monospace="true" title="Syntax"}} |
310 |
310 |
[%$<actionName>.<returnValue>%] |
311 |
311 |
{{/panel}} |
... |
... |
@@ -334,3 +334,4 @@ |
334 |
334 |
|
335 |
335 |
; [%$<actionName>.COUNT%] |
336 |
336 |
: The number of results. Evaluates to an integer value. |
|
287 |
+ |