... |
... |
@@ -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.UserInterface.MyForms.WorkflowProcessing.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 |
|
... |
... |
@@ -36,9 +36,9 @@ |
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.CreateTextFile]], [[Database query>>doc:Formcycle.Designer.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.Designer.Workflow.Actions.HtmlResponsePage]]. |
|
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.FormDesigner.Workflow.Actions.EMail]], [[Create text file>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WriteTextFile]], [[Database query>>doc:Formcycle.FormDesigner.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.FormDesigner.Workflow.Actions.ResponsePage]]. |
40 |
40 |
|
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//. |
|
41 |
+Example: The variable {{code language="none"}}[%tfEmail%]{{/code}} will take the value of the [[input field>>doc:Formcycle.FormDesigner.FormElements.Input]] named //tfEmail//. |
42 |
42 |
|
43 |
43 |
=== Special form elements === |
44 |
44 |
|
... |
... |
@@ -66,25 +66,17 @@ |
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 |
|
-: 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. |
|
69 |
+: {{version major="6" minor="1"/}}Returns the inbox name the form record currently resides in. |
74 |
74 |
; [%$PROCESS_ID%] |
75 |
75 |
: The current process ID of the form record. |
76 |
|
-; [%$PROJECT_ALIAS%] |
|
72 |
+; [%$PROJECT_ALIAS%]"}} |
77 |
77 |
: The alias of the current form. |
78 |
78 |
; [%$PROJECT_ID%] |
79 |
79 |
: The form ID of the current form. |
80 |
|
-; [%$PROJECT_TITLE%] |
81 |
|
-: The title of the current form. |
|
76 |
+; [%$PROJECT_NAME%] |
|
77 |
+: The name of the current form. |
82 |
82 |
; [%$RECORD_ID%] |
83 |
83 |
: 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 |
88 |
; [%$SOURCE_SERVER%] |
89 |
89 |
: The name of the server that has provided the current form, either the name of the {{fserver/}} or the local server. |
90 |
90 |
; [%$SOURCE_SERVER_URL%] |
... |
... |
@@ -101,15 +101,15 @@ |
101 |
101 |
{{/panel}} |
102 |
102 |
|
103 |
103 |
; [%$DATE("<format>", <lang>)%] |
104 |
|
-: 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}} |
105 |
105 |
; [%$FORM_DATE_CREATED("<format>", <lang>)%] |
106 |
|
-: 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}} |
107 |
107 |
; [%$FORM_DATE_MODIFIED("<format>", <lang>)%] |
108 |
|
-: 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}} |
109 |
109 |
|
110 |
110 |
{{id name="sec_user_variables"/}} |
111 |
111 |
|
112 |
|
-=== User variables === |
|
104 |
+=== User variables {{version major="6" minor="4" patch="0"/}} === |
113 |
113 |
|
114 |
114 |
{{id name="fig_prefill_user_variables"/}} |
115 |
115 |
{{figure image="prefill_user_variables_en.png"}}Using user variables to prefill form fields with data of the logged in user.{{/figure}} |
... |
... |
@@ -120,7 +120,7 @@ |
120 |
120 |
{{/html}} |
121 |
121 |
|
122 |
122 |
|
123 |
|
-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"]]). |
|
115 |
+User variables may be used in [[actions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]], [[templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]], [[data base queries>>Formcycle.UserInterface.Data.DBQueries.WebHome]] or directly in [[form elements>>Formcycle.FormDesigner.FormElements.WebHome]] for prefilling the form (see [[figure>>||anchor="fig_prefill_user_variables"]]). |
124 |
124 |
|
125 |
125 |
{{panel monospace="true" title="Syntax"}} |
126 |
126 |
[%$<user object>.<attribute>%] |
... |
... |
@@ -189,9 +189,9 @@ |
189 |
189 |
|
190 |
190 |
{{id name="sec_appointment_variables"/}} |
191 |
191 |
|
192 |
|
-=== Appointment variables === |
|
184 |
+=== Appointment variables {{version major="6" minor="5" patch="0"/}} === |
193 |
193 |
|
194 |
|
-Appointment variables can be used when [[appointments>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] are booked with the form. |
|
186 |
+Appointment variables can be used when [[appointments>>doc:Formcycle.FormDesigner.FormElements.Appointment.WebHome]] are booked with the form. |
195 |
195 |
|
196 |
196 |
{{panel monospace="true" title="Syntax"}} |
197 |
197 |
[%$<Name>%] |
... |
... |
@@ -239,7 +239,7 @@ |
239 |
239 |
[%$$<Name>%] |
240 |
240 |
{{/panel}} |
241 |
241 |
|
242 |
|
-A template variables takes the value of the content of a [[template>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] (for example [[text>>doc:Formcycle.UserInterface.FilesAndTemplates.Text]], [[email>>doc:Formcycle.UserInterface.FilesAndTemplates.Email]], or [[link>>doc:Formcycle.UserInterface.FilesAndTemplates.Link]]) and can be used by workflow action such as [[Email>>doc:Formcycle.Designer.Workflow.Actions.EMail]]. |
|
234 |
+A template variables takes the value of the content of a [[template>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] (for example [[text>>doc:Formcycle.UserInterface.FilesAndTemplates.Text]], [[email>>doc:Formcycle.UserInterface.FilesAndTemplates.Email]], or [[link>>doc:Formcycle.UserInterface.FilesAndTemplates.Link]]) and can be used by workflow action such as [[Email>>doc:Formcycle.FormDesigner.Workflow.Actions.EMail]]. |
243 |
243 |
|
244 |
244 |
=== Action variables === |
245 |
245 |
|