... |
... |
@@ -66,17 +66,27 @@ |
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. |
|
69 |
+: Returns the inbox name the form record currently resides in. |
|
70 |
+; [%$FORM_INBOX_LINK%] |
|
71 |
+: Returns the inbox link the form record currently resides in. |
|
72 |
+; [%$FORM_INVITE_LINK%] |
|
73 |
+: Returns the invitation link of the form. |
70 |
70 |
; [%$PROCESS_ID%] |
71 |
71 |
: The current process ID of the form record. |
72 |
|
-; [%$PROJECT_ALIAS%]"}} |
|
76 |
+; [%$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. |
|
80 |
+; [%$PROJECT_TITLE%] |
|
81 |
+: The title of the current form. |
78 |
78 |
; [%$RECORD_ID%] |
79 |
79 |
: The ID of the current form record. |
|
84 |
+; [%$RECORD_READ%] |
|
85 |
+: Whether the current form record was read. Evaluated as a Boolean, i.e. true or false. |
|
86 |
+; [%$RECORD_UNREAD%] |
|
87 |
+: Whether the current form record was not read. Evaluated as a Boolean, i.e. true or false. |
|
88 |
+; [%$RECORD_ATTR.<customAttrKey>%] |
|
89 |
+: 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,14 @@ |
85 |
85 |
: The ID of the current state. |
86 |
86 |
; [%$STATUS_NAME%] |
87 |
87 |
: The name of the current state. |
|
98 |
+; [%$STATUS_TYPE%] |
|
99 |
+: The type of the current state. These four values are possible: //RECEIVED// , //SAVED//, //ERROR// and //CUSTOM// (Custom status created by user). |
|
100 |
+; [%$TRIGGER.actionName%] |
|
101 |
+: The name of the action of the providing event. |
|
102 |
+; [%$TRIGGER.taskName%] |
|
103 |
+: The name of the task where the action of the event is located. |
|
104 |
+; [%$TRIGGER.triggerName%] |
|
105 |
+: The name of the event where the action of the event is located. |
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}} |
|
114 |
+: 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}} |
|
116 |
+: 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}} |
|
118 |
+: 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"/}} === |
|
122 |
+=== 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}} |
... |
... |
@@ -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"/}} === |
|
202 |
+=== 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 |
|
... |
... |
@@ -246,8 +246,13 @@ |
246 |
246 |
; [%$<actionName>.SUCCESS%] |
247 |
247 |
: Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false. |
248 |
248 |
; [%$<actionName>.COUNT%] |
|
267 |
+: This variable is not supported in the new workflow. |
249 |
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. |
|
273 |
+; [%$<actionName>.ERROR_CODE%] |
|
274 |
+: In case of error the thrown error code of the action. |
|
275 |
+; [%$<actionName>.ERROR_MESSAGE%] |
|
276 |
+: In case of error the thrown error message of the action. |