Changes for page Platzhalter


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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nlo
1 +XWiki.gru
Content
... ... @@ -36,7 +36,7 @@
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.Designer.Workflow.Actions.WriteTextFile]], [[Database query>>doc:Formcycle.Designer.Workflow.Actions.SQLStatement]] as well as for [[Templates>>doc:Formcycle.Designer.Workflow.Actions.ResponsePage]].
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  
... ... @@ -51,8 +51,6 @@
51 51  
52 52  === System variables ===
53 53  
54 -{{id name="system" /}}
55 -
56 56  {{panel monospace="true" title="Syntax"}}
57 57  [%$<Name>%]
58 58  {{/panel}}
... ... @@ -61,10 +61,6 @@
61 61  
62 62  ; [%$CLIENT_ID%]
63 63  : 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.
68 68  ; [%$FORM_LINK%]
69 69  : The URL of the current form.
70 70  ; [%$FORM_PROCESS_LINK%]
... ... @@ -72,28 +72,17 @@
72 72  ; [%$FORM_VERIFY_LINK%]
73 73  : The URL to confirm Double opt in. Can only be used once.
74 74  ; [%$FORM_INBOX_NAME%]
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.
69 +: {{version major="6" minor="1"/}}Returns the inbox name the form record currently resides in.
80 80  ; [%$PROCESS_ID%]
81 81  : The current process ID of the form record.
82 -; [%$PROJECT_ALIAS%]
72 +; [%$PROJECT_ALIAS%]"}}
83 83  : The alias of the current form.
84 84  ; [%$PROJECT_ID%]
85 85  : The form ID 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.
76 +; [%$PROJECT_NAME%]
77 +: The name of the current form.
89 89  ; [%$RECORD_ID%]
90 90  : 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.
97 97  ; [%$SOURCE_SERVER%]
98 98  : The name of the server that has provided the current form, either the name of the {{fserver/}} or the local server.
99 99  ; [%$SOURCE_SERVER_URL%]
... ... @@ -102,16 +102,6 @@
102 102  : The ID of the current state.
103 103  ; [%$STATUS_NAME%]
104 104  : 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]].
115 115  
116 116  ==== System variables with parameters ====
117 117  
... ... @@ -120,15 +120,15 @@
120 120  {{/panel}}
121 121  
122 122  ; [%$DATE("<format>", <lang>)%]
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}}
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}}
124 124  ; [%$FORM_DATE_CREATED("<format>", <lang>)%]
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}}
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}}
126 126  ; [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
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}}
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}}
128 128  
129 129  {{id name="sec_user_variables"/}}
130 130  
131 -=== User variables ===
104 +=== User variables {{version major="6" minor="4" patch="0"/}} ===
132 132  
133 133  {{id name="fig_prefill_user_variables"/}}
134 134  {{figure image="prefill_user_variables_en.png"}}Using user variables to prefill form fields with data of the logged in user.{{/figure}}
... ... @@ -139,7 +139,7 @@
139 139  {{/html}}
140 140  
141 141  
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"]]).
115 +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.FormDesigner.FormElements.WebHome]] for prefilling the form (see [[figure>>||anchor="fig_prefill_user_variables"]]).
143 143  
144 144  {{panel monospace="true" title="Syntax"}}
145 145  [%$&lt;user object&gt;.&lt;attribute&gt;%]
... ... @@ -208,7 +208,7 @@
208 208  
209 209  {{id name="sec_appointment_variables"/}}
210 210  
211 -=== Appointment variables ===
184 +=== Appointment variables {{version major="6" minor="5" patch="0"/}} ===
212 212  
213 213  Appointment variables can be used when [[appointments>>doc:Formcycle.Designer.Form.FormElements.Appointment.WebHome]] are booked with the form.
214 214  
... ... @@ -262,8 +262,6 @@
262 262  
263 263  === Action variables ===
264 264  
265 -{{id name="action" /}}
266 -
267 267  {{panel monospace="true" title="Syntax"}}
268 268  [%$&lt;actionName&gt;.&lt;returnValue&gt;%]
269 269  {{/panel}}
... ... @@ -274,22 +274,9 @@
274 274  
275 275  ; [%$<actionName>.SUCCESS%]
276 276  : 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.
277 277  ; [%$<actionName>.RESULT%]
278 278  : A single return value. Evaluates to a string value.
279 279  ; [%$<actionName>.RESULT[<Index>].<Identifier>%]
280 280  : 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 -