Changes for page Platzhalter

From version 28.1
edited by jdr
on 21.07.2021, 09:36
Change comment: There is no comment for this version
To version 7.1
edited by gru
on 29.06.2021, 14:14
Change comment: Renamed back-links.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.jdr
1 +XWiki.gru
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.FormDesigner.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  
... ... @@ -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.Designer.Workflow.Actions.EMail]], [[Create text file>>doc:Formcycle.FormDesigner.Workflow.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,27 +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 -; [%$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.
90 90  ; [%$SOURCE_SERVER%]
91 91  : The name of the server that has provided the current form, either the name of the {{fserver/}} or the local server.
92 92  ; [%$SOURCE_SERVER_URL%]
... ... @@ -95,14 +95,6 @@
95 95  : The ID of the current state.
96 96  ; [%$STATUS_NAME%]
97 97  : 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.
106 106  
107 107  ==== System variables with parameters ====
108 108  
... ... @@ -111,15 +111,15 @@
111 111  {{/panel}}
112 112  
113 113  ; [%$DATE("<format>", <lang>)%]
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}}
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}}
115 115  ; [%$FORM_DATE_CREATED("<format>", <lang>)%]
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}}
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}}
117 117  ; [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
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}}
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}}
119 119  
120 120  {{id name="sec_user_variables"/}}
121 121  
122 -=== User variables ===
104 +=== User variables {{version major="6" minor="4" patch="0"/}} ===
123 123  
124 124  {{id name="fig_prefill_user_variables"/}}
125 125  {{figure image="prefill_user_variables_en.png"}}Using user variables to prefill form fields with data of the logged in user.{{/figure}}
... ... @@ -130,7 +130,7 @@
130 130  {{/html}}
131 131  
132 132  
133 -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.FormDesigner.Workflow.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"]]).
134 134  
135 135  {{panel monospace="true" title="Syntax"}}
136 136  [%$&lt;user object&gt;.&lt;attribute&gt;%]
... ... @@ -199,9 +199,9 @@
199 199  
200 200  {{id name="sec_appointment_variables"/}}
201 201  
202 -=== Appointment variables ===
184 +=== Appointment variables {{version major="6" minor="5" patch="0"/}} ===
203 203  
204 -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.
205 205  
206 206  {{panel monospace="true" title="Syntax"}}
207 207  [%$&lt;Name&gt;%]
... ... @@ -264,13 +264,8 @@
264 264  ; [%$<actionName>.SUCCESS%]
265 265  : Whether the action could be processed successfully. Evaluates to a boolean, ie. true or false.
266 266  ; [%$<actionName>.COUNT%]
267 -: This variable is not supported in the new workflow.
268 268  : The number of results. Evaluates to an integer value.
269 269  ; [%$<actionName>.RESULT%]
270 270  : A single return value. Evaluates to a string value.
271 271  ; [%$<actionName>.RESULT[<Index>].<Identifier>%]
272 272  : 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.