Changes for page Platzhalter

From version 14.1
edited by gru
on 29.06.2021, 14:19
Change comment: Renamed back-links.
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
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  
... ... @@ -36,10 +36,26 @@
36 36  [%<FormFieldName>%]
37 37  {{/panel}}
38 38  
39 -This variable takes the value of the form field with the specified name. They are used mainly for actions such as [[Email>>doc:Formcycle.Designer.Workflow.Actions.EMail]], [[Create text file>>doc:Formcycle.Designer.Workflow.Actions.WriteTextFile]], [[Database query>>doc:Formcycle.Designer.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.Designer.Workflow.Actions.ResponsePage]].
39 +This variable takes the value of the form field with the specified name. They are used mainly for actions such as [[Email>>doc:Formcycle.Designer.Workflow.Actions.EMail]], [[Create text file>>doc:Formcycle.Designer.Workflow.Actions.CreateTextFile]], [[Database query>>doc:Formcycle.Designer.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.Designer.Workflow.Actions.HtmlResponsePage]].
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%]
... ... @@ -66,17 +66,30 @@
66 66  ; [%$FORM_VERIFY_LINK%]
67 67  : The URL to confirm Double opt in. Can only be used once.
68 68  ; [%$FORM_INBOX_NAME%]
69 -: {{version major="6" minor="1"/}}Returns the inbox name the form record currently resides in.
91 +: Returns the inbox name the form record currently resides in.
92 +; [%$FORM_INBOX_LINK%]
93 +: Returns the inbox link the form record currently resides in.
94 +; [%$FORM_INVITE_LINK%]
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.
70 70  ; [%$PROCESS_ID%]
71 71  : The current process ID of the form record.
72 -; [%$PROJECT_ALIAS%]"}}
100 +; [%$PROJECT_ALIAS%]
73 73  : The alias of the current form.
74 74  ; [%$PROJECT_ID%]
75 75  : The form ID of the current form.
76 -; [%$PROJECT_NAME%]
77 -: The name of the current form.
104 +; [%$PROJECT_TITLE%]
105 +: As of version 7, [%$PROJECT_NAME%] is now called [%$PROJECT_TITLE%] .
106 +: The title of the current form.
78 78  ; [%$RECORD_ID%]
79 79  : The ID of the current form record.
109 +; [%$RECORD_READ%]
110 +: Whether the current form record was read. Evaluated as a Boolean, i.e. true or false.
111 +; [%$RECORD_UNREAD%]
112 +: Whether the current form record was not read. Evaluated as a Boolean, i.e. true or false.
113 +; [%$RECORD_ATTR.<customAttrKey>%]
114 +: Read user-defined form record attributes (e.g. [%$RECORD_ATTR.loopCount%]). This allows values to be stored on the form record and accessed in any action.
80 80  ; [%$SOURCE_SERVER%]
81 81  : The name of the server that has provided the current form, either the name of the {{fserver/}} or the local server.
82 82  ; [%$SOURCE_SERVER_URL%]
... ... @@ -85,6 +85,16 @@
85 85  : The ID of the current state.
86 86  ; [%$STATUS_NAME%]
87 87  : The name of the current state.
123 +; [%$STATUS_TYPE%]
124 +: The type of the current state. These four values are possible: //RECEIVED// , //SAVED//, //ERROR// and //CUSTOM// (Custom status created by user).
125 +; [%$TRIGGER.actionName%]
126 +: The name of the action of the providing event.
127 +; [%$TRIGGER.taskName%]
128 +: The name of the task where the action of the event is located.
129 +; [%$TRIGGER.triggerName%]
130 +: The name of the event where the action of the event is located.
131 +; [%$COUNTER_CLIENT.<name of the counter>%]
132 +: The current value of a client [[counter>>doc:Formcycle.UserInterface.Data.Counter]].
88 88  
89 89  ==== System variables with parameters ====
90 90  
... ... @@ -93,15 +93,15 @@
93 93  {{/panel}}
94 94  
95 95  ; [%$DATE("<format>", <lang>)%]
96 -: {{version major="6" minor="0" patch="5"/}} Current date. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$DATE("yyyy/MM/dd", en-GB)%]{{/code}}
141 +: Current date. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$DATE("yyyy/MM/dd", en-GB)%]{{/code}}
97 97  ; [%$FORM_DATE_CREATED("<format>", <lang>)%]
98 -: {{version major="6" minor="0" patch="5"/}} Creation date of the form record. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$FORM_DATE_CREATED("yyyy/MM/dd", en-GB)%]{{/code}}
143 +: Creation date of the form record. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$FORM_DATE_CREATED("yyyy/MM/dd", en-GB)%]{{/code}}
99 99  ; [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
100 -: {{version major="6" minor="0" patch="5"/}} Available with FORMCYCLE version 6.0.5~{~{/info}} Last change date of the form record. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$FORM_DATE_MODIFIED("yyyy/MM/dd", en-GB)%]{{/code}}
145 +: Available with FORMCYCLE version 6.0.5~{~{/info}} Last change date of the form record. The parameters are optional. When no parameter is specified, the date will be returned in default format. You can specify a custom date format with the first parameter, see the [[java.text.SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]] for more info on the date format string. The second parameter specifies the language, which affects the names of weekdays and months. Example: {{code language="none"}}[%$FORM_DATE_MODIFIED("yyyy/MM/dd", en-GB)%]{{/code}}
101 101  
102 102  {{id name="sec_user_variables"/}}
103 103  
104 -=== User variables {{version major="6" minor="4" patch="0"/}} ===
149 +=== User variables ===
105 105  
106 106  {{id name="fig_prefill_user_variables"/}}
107 107  {{figure image="prefill_user_variables_en.png"}}Using user variables to prefill form fields with data of the logged in user.{{/figure}}
... ... @@ -112,8 +112,32 @@
112 112  {{/html}}
113 113  
114 114  
115 -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"]]).
116 116  
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 +
117 117  {{panel monospace="true" title="Syntax"}}
118 118  [%$&lt;user object&gt;.&lt;attribute&gt;%]
119 119  {{/panel}}
... ... @@ -120,7 +120,7 @@
120 120  
121 121  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.
122 122  
123 -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.
124 124  
125 125  
126 126  ==== User objects ====
... ... @@ -181,7 +181,7 @@
181 181  
182 182  {{id name="sec_appointment_variables"/}}
183 183  
184 -=== Appointment variables {{version major="6" minor="5" patch="0"/}} ===
253 +=== Appointment variables ===
185 185  
186 186  Appointment variables can be used when [[appointments>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] are booked with the form.
187 187  
... ... @@ -235,6 +235,8 @@
235 235  
236 236  === Action variables ===
237 237  
307 +{{id name="action"/}}
308 +
238 238  {{panel monospace="true" title="Syntax"}}
239 239  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
240 240  {{/panel}}
... ... @@ -245,9 +245,21 @@
245 245  
246 246  ; [%$<actionName>.SUCCESS%]
247 247  : Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false.
248 -; [%$<actionName>.COUNT%]
249 -: The number of results. Evaluates to an integer value.
250 250  ; [%$<actionName>.RESULT%]
251 251  : A single return value. Evaluates to a string value.
252 252  ; [%$<actionName>.RESULT[<Index>].<Identifier>%]
253 253  : 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.
323 +
324 +The following action variables are __not__ supported in the old workflow:
325 +
326 +; [%$<actionName>.ERROR_CODE%]
327 +: In case of error the thrown error code of the action.
328 +; [%$<actionName>.ERROR_MESSAGE%]
329 +: 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.