... |
... |
@@ -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%] |
... |
... |
@@ -88,30 +88,17 @@ |
88 |
88 |
; [%$FORM_VERIFY_LINK%] |
89 |
89 |
: The URL to confirm Double opt in. Can only be used once. |
90 |
90 |
; [%$FORM_INBOX_NAME%] |
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. |
|
69 |
+: {{version major="6" minor="1"/}}Returns the inbox name the form record currently resides in. |
98 |
98 |
; [%$PROCESS_ID%] |
99 |
99 |
: The current process ID of the form record. |
100 |
|
-; [%$PROJECT_ALIAS%] |
|
72 |
+; [%$PROJECT_ALIAS%]"}} |
101 |
101 |
: The alias of the current form. |
102 |
102 |
; [%$PROJECT_ID%] |
103 |
103 |
: The form ID 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. |
|
76 |
+; [%$PROJECT_NAME%] |
|
77 |
+: The name of the current form. |
107 |
107 |
; [%$RECORD_ID%] |
108 |
108 |
: 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. |
115 |
115 |
; [%$SOURCE_SERVER%] |
116 |
116 |
: The name of the server that has provided the current form, either the name of the {{fserver/}} or the local server. |
117 |
117 |
; [%$SOURCE_SERVER_URL%] |
... |
... |
@@ -120,16 +120,6 @@ |
120 |
120 |
: The ID of the current state. |
121 |
121 |
; [%$STATUS_NAME%] |
122 |
122 |
: 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]]. |
133 |
133 |
|
134 |
134 |
==== System variables with parameters ==== |
135 |
135 |
|
... |
... |
@@ -138,15 +138,15 @@ |
138 |
138 |
{{/panel}} |
139 |
139 |
|
140 |
140 |
; [%$DATE("<format>", <lang>)%] |
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}} |
|
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}} |
142 |
142 |
; [%$FORM_DATE_CREATED("<format>", <lang>)%] |
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}} |
|
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}} |
144 |
144 |
; [%$FORM_DATE_MODIFIED("<format>", <lang>)%] |
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}} |
|
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}} |
146 |
146 |
|
147 |
147 |
{{id name="sec_user_variables"/}} |
148 |
148 |
|
149 |
|
-=== User variables === |
|
104 |
+=== User variables {{version major="6" minor="4" patch="0"/}} === |
150 |
150 |
|
151 |
151 |
{{id name="fig_prefill_user_variables"/}} |
152 |
152 |
{{figure image="prefill_user_variables_en.png"}}Using user variables to prefill form fields with data of the logged in user.{{/figure}} |
... |
... |
@@ -157,30 +157,6 @@ |
157 |
157 |
{{/html}} |
158 |
158 |
|
159 |
159 |
|
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 |
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.WebHome]] or directly in [[form elements>>Formcycle.Designer.Form.FormElements.WebHome]] for prefilling the form (see [[figure>>||anchor="fig_prefill_user_variables"]]). |
185 |
185 |
|
186 |
186 |
{{panel monospace="true" title="Syntax"}} |
... |
... |
@@ -250,7 +250,7 @@ |
250 |
250 |
|
251 |
251 |
{{id name="sec_appointment_variables"/}} |
252 |
252 |
|
253 |
|
-=== Appointment variables === |
|
184 |
+=== Appointment variables {{version major="6" minor="5" patch="0"/}} === |
254 |
254 |
|
255 |
255 |
Appointment variables can be used when [[appointments>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] are booked with the form. |
256 |
256 |
|
... |
... |
@@ -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}} |
... |
... |
@@ -316,21 +316,9 @@ |
316 |
316 |
|
317 |
317 |
; [%$<actionName>.SUCCESS%] |
318 |
318 |
: 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. |
319 |
319 |
; [%$<actionName>.RESULT%] |
320 |
320 |
: A single return value. Evaluates to a string value. |
321 |
321 |
; [%$<actionName>.RESULT[<Index>].<Identifier>%] |
322 |
322 |
: 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. |