From version < 20.1 >
edited by nlo
on 14.05.2019, 11:13
To version < 34.2
edited by gru
on 19.06.2020, 14:58
<
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nlo
1 +XWiki.gru
Content
... ... @@ -33,7 +33,7 @@
33 33  * **Form**
34 34  Search for form records with the given form title.
35 35  * **Form record ID**
36 -Search for form records with the given ID {{info}}ID has to be exact.{{/info}}.
36 +Search for form records with the given ID. {{info}}ID has to be exact.{{/info}}
37 37  * **Process ID**
38 38  Search for form records with the given process ID.
39 39  * **State**
... ... @@ -69,6 +69,10 @@
69 69  * **Created by me**
70 70  All form records that have been created by the current [[user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] will be displayed.
71 71  
72 +{{id name="filter_menu_appointment_templates" /}}
73 +=== Schedules {{version major="6" minor="5" patch="0"/}} ===
74 +This filter menu is only available in the [[calendar view>>||anchor="calendar-view"]]. Schedules that have booked appointments can be (un-)selected here. In the calendar-view only appointments of the selected schedules will appear.
75 +
72 72  === Inboxes ===
73 73  
74 74  {{id name="filter_menu_inboxes"/}}
... ... @@ -140,6 +140,8 @@
140 140  Clicking on a form record in the form record list opens it in the [[review area>>||anchor="review_area"]]. If the review area is not visible, it will be opened by clicking on a form record. After opening a form record it will be marked as read and the font weight will be set from //bold// to //normal//. When filtering unread form records this record will be excluded. For marking a form record //unread// click the appropriate button {{icon name="envelope"/}} in the header of the form record list.
141 141  The form record list header consists of two button rows (see [[figure>>||anchor="fig_inbox_list_default_marked"]]). On the left are //form record actions// and on the right are //general actions//.
142 142  
147 +{{id name="form_record_actions"/}}
148 +
143 143  === Form record actions ===
144 144  
145 145  Which form record actions will be displayed depends on the currently selected form records.
... ... @@ -152,57 +152,8 @@
152 152  
153 153  Exports all selected form records or all form records based on the currently [[set filters>>||anchor="filter_menu"]] if there are no form records selected.
154 154  
155 -Example:
161 +For further information on form record export see [[Export>>||anchor="export"]].
156 156  
157 -No form records are selected and filter is set to the inbox "Default inbox". Performing an export action will export all form records that are stored in the inbox "Default inbox". For exporting the form records of all inboxes the filter on "Default inbox" needs to be removed.
158 -
159 -There are three different types of exporting form records:
160 -
161 -__{{icon name="file-code-o"/}} XML__
162 -{{figure image="inbox_export_xml_en.png"}}{{id name="fig_inbox_export_xml" /}}
163 -XML-Export of selected form records: Optionally an XSL-Template may be selected for transforming the resulting XML file into the desired format (XSL-Templates can be defined under [[XSL transformation>>Formcycle.UserInterface.FilesAndTemplates.XSLTransformation.WebHome]]).{{/figure}}
164 -
165 -Form record data of all form elements will be exported flat in an XML structure.
166 -
167 -{{code language="xml"}}
168 -<xfc-data xfc-version="3.x.x" generation-date="yyyy-mm-dd HH:mm:ss.ms TZ">
169 - <processes>
170 - <process process-uid="xxx" creation-date="yyyy-mm-dd HH:mm:ss.ms TZ" project-name="yyy" status="zzz">
171 - <form version="1">
172 - <field name="elName">
173 - <plainValue><![CDATA[Wert]]></plainValue>
174 - <values count="1">
175 - <value index="0"><![CDATA[]]></value>
176 - </values>
177 - <label><![CDATA[]]></label>
178 - </field>
179 - ...
180 - </form>
181 - <process ...>
182 - </processes>
183 -</xfc-data>
184 -{{/code}}
185 -
186 -Using an optional XSL template (see [[figure>>||anchor="fig_inbox_export_xml"]]) the exported XML can be transformed into the desired format. The appropriate template can be selected using the combobox. For further information on XSL templates look [[here>>doc:Formcycle.UserInterface.FilesAndTemplates.XSLTransformation]].
187 -
188 -__{{icon name="file-excel-o"/}} Excel__
189 -{{figure image="inbox_export_excel_en.png"}}{{id name="fig_inbox_export_excel" /}}
190 -Excel export of the selected form records: Column names can be configured for every export.{{/figure}}
191 -
192 -All data will be exported to an Excel file. If form records of multiple forms have been selected than a new worksheet will be created for every form within the Excel file. All values of [[dynamic form elements>>Formcycle.FormDesigner.CodingPanel.ScriptTab.AdditionalScriptFunctions.Dynamic.WebHome]] will be put into the same cell, separated by commas. If this is not desired the export option //Excel (multiline)// is recommended.
193 -The column names of the resulting Excel file may configured using the following options:
194 -
195 -* **Name of the form element**
196 -The element names that are used in the [[{{designer/}}>>doc:Formcycle.FormDesigner.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns (e.g.: tf1, sel1, ...).
197 -* **Alias of the form element**
198 -The element alias that is used in the [[{{designer/}}>>doc:Formcycle.FormDesigner.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns.
199 -* **Column name of the data table**
200 -The column names that have been set in the [[inbox configuration>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]] will be used for the Excel columns. This selection is only available in the [[project views>>||anchor="inbox_list_project"]].
201 -
202 -__{{icon name="file-excel-o"/}} Excel (multiline)__
203 -{{info}}This Option is not available in [[project views>>||anchor="inbox_list_project"]].{{/info}}
204 -The export works the exact same way as the simple Excel export, except that the values of [[dynamic form elements>>Formcycle.FormDesigner.CodingPanel.ScriptTab.AdditionalScriptFunctions.Dynamic.WebHome]] will be put into separate rows.
205 -
206 206  ==== {{ficon name="action-move-inbox"/}} Move ====
207 207  
208 208  {{figure image="inbox_move_en.png"}}
... ... @@ -244,6 +244,11 @@
244 244  A form record in the default view: Clicking the inbox (in blue) sets an [[inbox filter>>||anchor="filter_menu_inboxes"]]. The attachment page of the form record can be accessed directly be clicking the paperclip icon {{ficon name="paperclip-45" /}}.{{/figure}}
245 245  In contrast to the [[project views>>||anchor="inbox_list_project"]] and depending on the [[set filters>>||anchor="filter_menu"]], all form records are being displayed in the default view. Form records with attachments are marked by a paperclip icon {{ficon name="paperclip-45"/}} (see [[figure>>||anchor="fig_inbox_list_item_default"]]). Clicking the icon opens the [[attachment page>>||anchor="review_area_attachments"]] of the form record directly. Every record entry consists of the subject, submit date, state as well as the inbox (in blue, see [[figure>>||anchor="fig_inbox_list_item_default"]]). Clicking the inbox sets an [[inbox filter>>||anchor="filter_menu_inboxes"]].
246 246  
204 +{{id name="calendar-view" /}}
205 +=== Calendar view {{version major="6" minor="5" patch="0"/}} ===
206 +
207 +The calendar view is available if [[schedules>>doc:Formcycle.UserInterface.Appointments.WebHome]] with booked appointments exist. In this view all booked appointments are displayed. Which schedules should be displayed can be set from the [[filter menu>>||anchor="filter_menu_appointment_templates"]].
208 +
247 247  === Project view ===
248 248  
249 249  {{id name="inbox_list_project"/}}
... ... @@ -255,6 +255,96 @@
255 255  
256 256  Project views are data table views which are available as soon as display columns have been configured for the form (see [[Form > Inbox>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]]). The values of the configured form elements as well as additional form information will be displayed in the data table. Every column can be filtered and sorted. Form records containing attachments are marked by a paperclip icon {{ficon name="paperclip-45"/}} (see [[figure>>||anchor="fig_inbox_list_item_default"]]). Clicking the icon opens the [[attachment page>>||anchor="review_area_attachments"]] of the form record directly.
257 257  
220 +{{id name="export"/}}
221 +
222 +== Export ==
223 +
224 +Clicking //Export// {{icon name="download"/}} in the header of the form record list exports all selected form records or all form records based on the currently [[set filters>>||anchor="filter_menu"]] if there are no form records selected (see [[form record actions>>||anchor="form_record_actions"]]).
225 +
226 +__Example:__
227 +
228 +No form records are selected and filter is set to the inbox "Default inbox". Performing an export action will export all form records that are stored in the inbox "Default inbox". For exporting the form records of all inboxes the filter on "Default inbox" needs to be removed.
229 +
230 +There are three different types of exporting form records:
231 +
232 +=== {{icon name="file-code-o"/}} XML ===
233 +
234 +{{figure image="inbox_export_xml_en.png"}}
235 +{{id name="fig_inbox_export_xml" /}}
236 +XML-Export of selected form records: Optionally an XSL-Template may be selected for transforming the resulting XML file into the desired format (XSL-Templates can be defined under [[XSL transformation>>Formcycle.UserInterface.FilesAndTemplates.XSLTransformation.WebHome]]). Additionally meta data may be exported.
237 +{{/figure}}
238 +
239 +Form record data of all form elements will be exported flat in an XML structure.
240 +
241 +{{code language="xml"}}
242 +<xfc-data xfc-version="3.x.x" generation-date="yyyy-mm-dd HH:mm:ss.ms TZ">
243 + <processes>
244 + <process process-uid="xxx" creation-date="yyyy-mm-dd HH:mm:ss.ms TZ" project-name="yyy" status="zzz">
245 + <form version="1">
246 + <field name="elName">
247 + <plainValue><![CDATA[Wert]]></plainValue>
248 + <values count="1">
249 + <value index="0"><![CDATA[]]></value>
250 + </values>
251 + <label><![CDATA[]]></label>
252 + </field>
253 + ...
254 + </form>
255 + <process ...>
256 + </processes>
257 +</xfc-data>
258 +{{/code}}
259 +
260 +Using an optional XSL template (see [[figure>>||anchor="fig_inbox_export_xml"]]) the exported XML can be transformed into the desired format. The appropriate template can be selected using the combobox. For further information on XSL templates look [[here>>doc:Formcycle.UserInterface.FilesAndTemplates.XSLTransformation]].
261 +
262 +=== {{icon name="file-excel-o"/}} Excel ===
263 +
264 +{{figure image="inbox_export_excel_en.png"}}
265 +{{id name="fig_inbox_export_excel" /}}
266 +Excel export of the selected form records: Column names can be configured for every export. Additionally meta data may be exported.
267 +{{/figure}}
268 +
269 +All data will be exported to an Excel file. If form records of multiple forms have been selected than a new worksheet will be created for every form within the Excel file. All values of [[repeated form elements>>Formcycle.FormDesigner.ElementProperties.BaseProperties]] will be put into the same cell, separated by commas. If this is not desired the export option //Excel (multiline)// is recommended.
270 +The column names of the resulting Excel file may configured using the following options:
271 +
272 +* **Name of the form element**
273 +The element names that are used in the [[{{designer/}}>>doc:Formcycle.FormDesigner.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns (e.g.: tf1, sel1, ...).
274 +* **Alias of the form element**
275 +The element alias that is used in the [[{{designer/}}>>doc:Formcycle.FormDesigner.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns.
276 +* **Column name of the data table**
277 +The column names that have been set in the [[inbox configuration>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]] will be used for the Excel columns. This selection is only available in the [[project views>>||anchor="inbox_list_project"]].
278 +
279 +=== {{icon name="file-excel-o"/}} Excel (multiline) ===
280 +
281 +{{info}}This Option is not available in [[project views>>||anchor="inbox_list_project"]].{{/info}}
282 +The export works the exact same way as the simple Excel export, except that the values of [[repeated form elements>>Formcycle.FormDesigner.ElementProperties.BaseProperties]] will be put into separate rows.
283 +
284 +=== Export meta data (Optional) ===
285 +
286 +{{info}}This functionality is available in FORMCYCLE version 6.1.0 and above. In previous versions meta data was exported by default.{{/info}}
287 +Meta data may be exported additionally for every export type (see figure [[XML export>>||anchor="fig_inbox_export_xml"]]/[[Excel export>>||anchor="fig_inbox_export_excel"]]). The following fileds are available for export:
288 +
289 +* **ID** {{version major="6" minor="4" patch="0"/}}
290 +System ID of the form record.
291 +* **Process ID**
292 +Process ID of the form record.
293 +* **Subject** {{version major="6" minor="4" patch="0"/}}
294 +Subject of the form record.
295 +* **Status**
296 +Name of the state the form record is in at the time of export.
297 +* **Inbox** {{version major="6" minor="4" patch="0"/}}
298 +* Inbox in which the form record is located.
299 +* **Date of receipt**
300 +Date the form record was submitted/created.
301 +* **Modification date**
302 +Date of last change to the form record.
303 +* **Form variables**
304 +Configured [[Form variables>>doc:Formcycle.FormDesigner.CodingPanel.VariablesTab]] an their values.
305 +* **Control fields**
306 +Control fields of the form such as //xf-action//, which holds the name of the button used for submitting the form.
307 +* **Meta data**
308 +Date of export and used FORMCYCLE version.
309 +
258 258  == Review area ==
259 259  
260 260  {{id name="review_area"/}}
... ... @@ -292,6 +292,9 @@
292 292  
293 293  === Navigation row ===
294 294  
347 +{{figure image="inbox_review_area_attachments_en.png"}}The attachment area of a form record is divided into form upload attachments and workflow attachments. Attachments with a size of 0 Byte will be marked red.{{/figure}}
348 +{{id name="fig_inbox_review_area_attachments"/}}
349 +
295 295  The navigation row provides a number of tabs for displaying different aspects of the form record. Depending on the selected navigation tab the available actions in the action row change as well as the displayed information in the content area.
296 296  
297 297  * **{{ficon name="XPage"/}} Form page**
... ... @@ -308,7 +308,7 @@
308 308  Shows the protocol entries (history) of the current form record. State changes, executed actions, attached files, etc. will be logged and displayed here. This tab provides the following form record actions:
309 309  ** {{ficon name="plus-circle-outline"/}} [[Add entry>>||anchor="review_action_add_protocol_entry"]]
310 310  * **{{ficon name="paperclip-45"/}} Attachments**{{id name="review_area_attachments"/}}
311 -If the form record contains attachments this tab will be displayed and allows access to the form record attachments.
366 +If the form record contains attachments this tab will be displayed and allows access to the form record attachments. The attachment area of a form record is divided into form upload attachments and workflow attachments. Form uploads are attached via [[upload elements>>doc:Formcycle.FormDesigner.FormElements.Upload]] of a form. Workflow attachments will be generated through workflow processing actions. Attachments with a size of 0 Byte will be marked red.
312 312  ** {{ficon name="checkbox-marked-outline"/}} (De-)Selectionof all attachments
313 313  ** {{icon name="download"/}} [[Download>>||anchor="review_action_download_attach"]]
314 314  ** {{ficon name="trash-alt2"/}} [[Delete attachments>>||anchor="review_action_delete_attach"]]
... ... @@ -329,7 +329,7 @@
329 329  ** //Rerun actions of the current state//: Reruns the actions of the current state. Whether or not form data changes should be saved and validated can be configured.
330 330  ** //Change state//: Similar to the normal state change. Whether or not the actions of the destination state should be executed and whether or not form data changes should be saved and validated can be configured. This action is only available if the state can be changed by the user.
331 331  * **{{ficon name="plus-circle-outline"/}} Add entry**{{id name="review_action_add_protocol_entry"/}}
332 -Opens up a dialog for adding protocol entries to the form record history. Selected files will be attached to the form record.
387 +Opens up a dialog for adding protocol entries to the form record history. It is also possible to select additional files which will be attached to the form record.
333 333  * **{{icon name="download"/}} Download attachments**{{id name="review_action_download_attach"/}}
334 334  Downloads the selected attachments.
335 335  * **{{ficon name="trash-alt2"/}} Delete attachments**{{id name="review_action_delete_attach"/}}
Copyright 2000-2024