Changes for page Platzhalter

From version 7.1
edited by gru
on 29.06.2021, 14:14
Change comment: Renamed back-links.
To version 36.1
edited by nlo
on 14.10.2021, 16:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.gru
1 +XWiki.nlo
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.FormDesigner.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.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.FormDesigner.Workflow.Actions.WriteTextFile]], [[Database query>>doc:Formcycle.FormDesigner.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.FormDesigner.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 -Example: The variable {{code language="none"}}[%tfEmail%]{{/code}} will take the value of the [[input field>>doc:Formcycle.FormDesigner.FormElements.Input]] named //tfEmail//.
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 43  === Special form elements ===
44 44  
... ... @@ -51,6 +51,8 @@
51 51  
52 52  === System variables ===
53 53  
54 +{{id name="system" /}}
55 +
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.
64 +; [%$CLIENT_MAIL_SENDER%] {{version major="7" minor="0" patch="4" /}}
65 +: Returns the mail sender address of the client. If none has been set then an empty string will be returned.
66 +; [%$CLIENT_MAIL_SENDERNAME%] {{version major="7" minor="0" patch="4" /}}
67 +: Returns the mail sender name of the client. If none has been set then an empty string will be returned.
62 62  ; [%$FORM_LINK%]
63 63  : The URL of the current form.
64 64  ; [%$FORM_PROCESS_LINK%]
... ... @@ -66,17 +66,28 @@
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.
75 +: Returns the inbox name the form record currently resides in.
76 +; [%$FORM_INBOX_LINK%]
77 +: Returns the inbox link the form record currently resides in.
78 +; [%$FORM_INVITE_LINK%]
79 +: Returns the invitation link of the form.
70 70  ; [%$PROCESS_ID%]
71 71  : The current process ID of the form record.
72 -; [%$PROJECT_ALIAS%]"}}
82 +; [%$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.
86 +; [%$PROJECT_TITLE%]
87 +: As of version 7, [%$PROJECT_NAME%] is now called [%$PROJECT_TITLE%] .
88 +: The title of the current form.
78 78  ; [%$RECORD_ID%]
79 79  : The ID of the current form record.
91 +; [%$RECORD_READ%]
92 +: Whether the current form record was read. Evaluated as a Boolean, i.e. true or false.
93 +; [%$RECORD_UNREAD%]
94 +: Whether the current form record was not read. Evaluated as a Boolean, i.e. true or false.
95 +; [%$RECORD_ATTR.<customAttrKey>%]
96 +: 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.
105 +; [%$STATUS_TYPE%]
106 +: The type of the current state. These four values are possible: //RECEIVED// , //SAVED//, //ERROR// and //CUSTOM// (Custom status created by user).
107 +; [%$TRIGGER.actionName%]
108 +: The name of the action of the providing event.
109 +; [%$TRIGGER.taskName%]
110 +: The name of the task where the action of the event is located.
111 +; [%$TRIGGER.triggerName%]
112 +: The name of the event where the action of the event is located.
113 +; [%$COUNTER_CLIENT.<name of the counter>%]
114 +: 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}}
123 +: 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}}
125 +: 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}}
127 +: 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"/}} ===
131 +=== 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,7 +112,7 @@
112 112  {{/html}}
113 113  
114 114  
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"]]).
142 +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  
117 117  {{panel monospace="true" title="Syntax"}}
118 118  [%$&lt;user object&gt;.&lt;attribute&gt;%]
... ... @@ -181,9 +181,9 @@
181 181  
182 182  {{id name="sec_appointment_variables"/}}
183 183  
184 -=== Appointment variables {{version major="6" minor="5" patch="0"/}} ===
211 +=== Appointment variables ===
185 185  
186 -Appointment variables can be used when [[appointments>>doc:Formcycle.FormDesigner.FormElements.Appointment.WebHome]] are booked with the form.
213 +Appointment variables can be used when [[appointments>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] are booked with the form.
187 187  
188 188  {{panel monospace="true" title="Syntax"}}
189 189  [%$&lt;Name&gt;%]
... ... @@ -235,6 +235,8 @@
235 235  
236 236  === Action variables ===
237 237  
265 +{{id name="action" /}}
266 +
238 238  {{panel monospace="true" title="Syntax"}}
239 239  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
240 240  {{/panel}}
... ... @@ -245,9 +245,22 @@
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.
281 +
282 +The following action variables are __not__ supported in the old workflow:
283 +
284 +; [%$<actionName>.ERROR_CODE%]
285 +: In case of error the thrown error code of the action.
286 +; [%$<actionName>.ERROR_MESSAGE%]
287 +: In case of error the thrown error message of the action.
288 +
289 +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()%]**
290 +
291 +The following action variable is __only__ supported in the old workflow:
292 +
293 +; [%$<actionName>.COUNT%]
294 +: The number of results. Evaluates to an integer value.
295 +