Wiki source code of Posteingang

Hide last authors
gru 1.1 1 {{content/}}
2
3
sas 168.1 4 == Description ==
gru 1.1 5
sas 168.1 6 Depending on the authorization all submitted [[form records>>doc:Terminology.WebHome||anchor="form_record"]] will be displayed clearly in either the [[//default view//>>||anchor="inbox_list_default"]] or [[//project view//>>||anchor="inbox_list_project"]]. In the inbox it is also possible to change the state of form records, upload files, write comments and export form record data.
gru 1.1 7
sas 168.1 8 == Structure ==
gru 1.1 9
sas 168.1 10 {{figure image="inbox_overview_marked_en.png"}}
gru 1.1 11 {{id name="fig_inbox_overview" /}}
sas 168.1 12 The inbox consists of (1) the //filter menu//, (2) the //form record list// and (3) the //review area//.
gru 1.1 13 {{/figure}}
14
sas 168.1 15 As a whole the inbox consists of three separate parts: the [[filte menu>>||anchor="filter_menu"]] at the left side, the [[form record list>>||anchor="inbox_list"]] and the [[review area>>||anchor="review_area"]]. When the inbox is being opened only the filter menu and the form record list are visible. A click on a form record within the form record list opens the review area of that form record.
gru 1.1 16
sas 168.1 17 == Filter menu ==
gru 1.1 18
19 {{id name="filter_menu"/}}
sas 168.1 20 The filter menu is used for configuring how the form records are being displayed within the form record list. The following filters are provided:
gru 1.1 21
sas 168.1 22 === Search ===
gru 1.1 23
sas 168.1 24 {{figure image="inbox_filter_menu_search_type_en.png"}}
gru 1.1 25 {{id name="fig_inbox_filter_menu_search_type" /}}
sas 168.1 26 Form record search: Form records can be filtered by different search types. The search type can be selected via the arrow symbol which is marked in red.
gru 1.1 27 {{/figure}}
28
sas 168.1 29 At the top of the filter menu there is an input field for searching forms. The arrow button to the right of the is being used to select the search type (see [[figure>>||anchor="fig_inbox_filter_menu_search_type"]]). The following search types are provided:
gru 1.1 30
sas 168.1 31 * **Subject**
32 Search for form records with the given subject.
33 * **Form**
34 Search for form records with the given form title.
35 * **Form record ID**
36 Search for form records with the given ID. {{info}}ID has to be exact.{{/info}}
37 * **Process ID**
38 Search for form records with the given process ID.
39 * **State**
40 Search for form records that are in the given state.
gru 1.1 41
sas 168.1 42 No search filter is being applied if the input field is empty. In project views the input field is not being displayed.
gru 1.1 43
sas 168.1 44 === View ===
45
jdr 84.1 46 {{id name="filter_menu_view"/}}
sas 168.1 47 {{figure image="inbox_filter_menu_view_en.png"}}{{id name="fig_inbox_filter_menu_view" /}}
48 There are three different types of views, which can be differentiated by their symbols {{ficon name="view-list"/}} / {{ficon name="date"/}} / {{ficon name="layout-table"/}} : (1) the //default view// of form records, (2) the //calendar view// and (3) the //project views// (marked in red).{{/figure}}
jdr 84.1 49
gru 1.1 50
sas 168.1 51 {{html wiki="true"}}
52 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
53 There are three different types of views, which can be differentiated by their symbols / / : (1) the default view of form records, (2) the calendar view and (3) the project views (marked in red).'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_filter_menu_view_en.png' width='300' group='$height' group='$group' title='
54 There are three different types of views, which can be differentiated by their symbols / / : (1) the default view of form records, (2) the calendar view and (3) the project views (marked in red).'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_filter_menu_view" /}}
55 There are three different types of views, which can be differentiated by their symbols {{ficon name="view-list"/}} / {{ficon name="date"/}} / {{ficon name="layout-table"/}} : (1) the //default view// of form records, (2) the //calendar view// and (3) the //project views// (marked in red).</div></div></div>
56 {{/html}}
gru 1.1 57
58
sas 168.1 59 The view selection is only available if project views have been configured (for configuring project views see [[My Forms > Inbox>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]]). Which form records are being displayed in the form record list and how they are being displayed depends on the selected view. There are two different types of views:
gru 1.1 60
sas 168.1 61 * {{ficon name="view-list"/}} **Default**
62 The default view can not be configured. Depending on the users authorization all submitted [[form records>>doc:Terminology.WebHome||anchor="form_record"]] are displayed in the [[form record list>>||anchor="inbox_list_default"]].
63 * {{ficon name="date"/}}**Calendar view**
64 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"]].
65 * {{ficon name="layout-table"/}} **Project views**
66 Project views have the names of the forms they are matched to. These views only contain form records of the appropriate form. The form records will be displayed in a data table. The number of columns depends on the [[view configuration>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]] (see [[form record list>>||anchor="inbox_list_project"]]).
gru 1.1 67
68 === Filter ===
69
sas 168.1 70 {{figure image="inbox_filter_menu_filter_en.png"}}
gru 1.1 71 {{id name="fig_inbox_filter_menu_filter" /}}
sas 168.1 72 Filter: There are four quick filters available.
gru 1.1 73 {{/figure}}
74
75
sas 168.1 76 {{html wiki="true"}}
77 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
78 Filter: There are four quick filters available.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_filter_menu_filter_en.png' width='300' group='$height' group='$group' title='
79 Filter: There are four quick filters available.'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_filter_menu_filter" /}}
80 Filter: There are four quick filters available.</div></div></div>
81 {{/html}}
gru 1.1 82
sas 168.1 83
84 There are four quick filters available for configuring the form record list.
85
86
87 * **Show all**
88 All form records of the current [[view>>doc:||anchor="filter_menu_view"]] will be displayed.
89 * **Recently edited**
90 All form records that have been edited in the past 14 days will be displayed.
91 * **Edited by me**
92 All form records that have been edited by the current [[user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] will be displayed.
93 * **Created by me**
94 All form records that have been created by the current [[user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] will be displayed.
95
jdr 42.1 96 {{id name="filter_menu_appointment_templates"/}}
97
sas 168.1 98 === Schedules ===
jdr 42.1 99
sas 168.1 100 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.
gru 1.1 101
sas 168.1 102 === Inboxes ===
gru 1.1 103
104 {{id name="filter_menu_inboxes"/}}
105
sas 168.1 106 {{figure image="inbox_filter_menu_inboxes_en.png"}}
gru 1.1 107 {{id name="fig_inbox_filter_menu_inboxes" /}}
sas 168.1 108 Only form records within the selected inboxes will be displayed.
gru 1.1 109 {{/figure}}
110
sas 168.1 111 Every form record is stored in an [[inbox>>doc:Formcycle.UserInterface.Inboxes.WebHome]]. By default this is the //Default inbox//. What inbox a form record should be stored in can be configured in the [[inbox settings>>doc:Formcycle.UserInterface.MyForms.Inbox.WebHome]] of the form. By selecting inboxes only the form records within the selected inboxes will be displayed. Next to each inbox a number is diplayed showing the count of unread form records within that inbox. Is no number present than there are no unread form records. Is no inbox selected or the inbox filter is not available (because all form records are stored in the same inbox) than the form records of all inboxes will be displayed.
gru 1.1 112
sas 168.1 113 The inbox filter depends on the selected [[view>>||anchor="filter_menu_view"]]. The inbox filter is available if the form records of the form record list are stored in more than one inbox. If this is not the case than the inbox filter is not available.
gru 1.1 114
sas 168.1 115 === Submit date / Change date ===
116
117 {{figure image="inbox_filter_menu_date_en.png"}}
gru 1.1 118 {{id name="fig_inbox_filter_menu_date" /}}
sas 168.1 119 The form record list can be filtered by submit date.
gru 1.1 120 {{/figure}}
121
sas 168.1 122 The form record list can be filtered by the submit date and the change date of the form records. For this purpose, two input fields are available in each case:
gru 1.1 123
sas 168.1 124 * **from**
125 All form records that have been received or changed since the specified date are displayed.
126 * **until**
127 All form records that have been received or changed until the specified date are displayed.
gru 1.1 128
sas 168.1 129 If the fields are empty, there is no restriction based on the date.
gru 1.1 130
sas 168.1 131 === Sorting ===
gru 1.1 132
sas 168.1 133 {{figure image="inbox_filter_menu_sort_en.png"}}
gru 1.1 134 {{id name="fig_inbox_filter_menu_sort" /}}
sas 168.1 135 The default view of the form record list can be sorted by different criteria.
gru 1.1 136 {{/figure}}
137
sas 168.1 138 The default view of the form record list can be sorted by different criteria. If a project view is selected this field is not available. [[Sorting of project views>>||anchor="inbox_list_project"]] is done by clicking on the column headers. The following criteria (in ascending and descending direction) are available for sorting:
gru 1.1 139
sas 168.1 140 * **Submit date**
141 * **Last change date**
142 * **Subject**
143 * **State**
gru 1.1 144
sas 168.1 145 === More filters ===
gru 1.1 146
sas 168.1 147 {{figure image="inbox_filter_menu_others_en.png"}}
gru 1.1 148 {{id name="fig_inbox_filter_menu_others" /}}
sas 168.1 149 More filters for individual searches.
gru 1.1 150 {{/figure}}
151
sas 168.1 152 More filters are provided for further refinement of the search:
gru 1.1 153
sas 168.1 154 * **(Un-)Read**
155 Only (un-)read form records will be displayed.
156 * **With/Without attachment**
157 Only form records with/without attachments will be displayed.
158 * **(Not) Saved**
159 Only form records that are (not) saved will be displayed.
160 * **(No) Double-Opt-In**
161 Only form records that are in the state //Waiting for Opt-In// will be displayed (see [[Double-Opt-In>>doc:Formcycle.UserInterface.MyForms.DoubleOptIn.WebHome]] for configuration).
gru 1.1 162
sas 168.1 163 == Form record list ==
gru 1.1 164
165 {{id name="inbox_list"/}}
sas 168.1 166 {{figure image="inbox_list_default_marked_en.png"}}{{id name="fig_inbox_list_default_marked" /}}
167 The form record actions on the left side of the form record list header are displayed if any form records have been selected. General actions on the left side are always visible.{{/figure}}
gru 1.1 168
169
sas 168.1 170 {{html wiki="true"}}
171 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
172 The form record actions on the left side of the form record list header are displayed if any form records have been selected. General actions on the left side are always visible.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_list_default_marked_en.png' width='300' group='$height' group='$group' title='
173 The form record actions on the left side of the form record list header are displayed if any form records have been selected. General actions on the left side are always visible.'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_list_default_marked" /}}
174 The form record actions on the left side of the form record list header are displayed if any form records have been selected. General actions on the left side are always visible.</div></div></div>
175 {{/html}}
176
177
178 All form records are displayed in the form record list depending on the [[set filters>>||anchor="filter_menu"]]. There are two different views of the form record list: the [[default view>>||anchor="inbox_list_default"]] and the [[project view>>||anchor="inbox_list_project"]]. The view can be changed in the [[filter menu>>||anchor="filter_menu_view"]].
179 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.
180 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//.
181
gru 1.1 182 {{id name="form_record_actions"/}}
183
sas 168.1 184 === Form record actions ===
gru 1.1 185
sas 168.1 186 Which form record actions will be displayed depends on the currently selected form records.
gru 1.1 187
sas 168.1 188 ==== {{ficon name="checkbox-marked-outline"/}} Select all form records ====
gru 1.1 189
sas 168.1 190 Selects all form records based on the currently [[set filters>>||anchor="filter_menu"]]. {{info}}This may take a while if there is a large number of form records within the list.{{/info}} This checkbox is always available.
gru 1.1 191
sas 168.1 192 ==== {{icon name="download"/}} Export ====
gru 1.1 193
sas 168.1 194 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.
gru 1.1 195
sas 168.1 196 For further information on form record export see [[Export>>||anchor="export"]].
gru 1.1 197
sas 168.1 198 ==== {{ficon name="action-move-inbox"/}} Move ====
gru 1.1 199
sas 168.1 200 {{figure image="inbox_move_en.png"}}
gru 1.1 201 {{id name="fig_inbox_move" /}}
sas 168.1 202 Moves the selected form records to a different inbox.
gru 1.1 203 {{/figure}}
204
sas 168.1 205 Clicking the move button (see [[figure>>||anchor="fig_inbox_move"]]) opens a dialog in which the desired inbox must be chosen. All selected form records will be moved to that inbox after confirming. Moving form records does not trigger any action of the workflow.
gru 1.1 206
sas 168.1 207 ==== {{icon name="envelope"/}}/{{icon name="envelope-open"/}} (Un-)Read ====
gru 1.1 208
sas 168.1 209 Clicking the //Read// or //Unread// button markes the selected form records as read or unread.
gru 1.1 210
sas 168.1 211 ==== {{ficon name="trash-alt2"/}} Delete ====
gru 1.1 212
sas 168.1 213 Clicking this button deletes the selected form records. This function is only available if all selected form records are deletable. A form record is deletable if the state, it is currently in, allows for it to be deleted. In the [[state configuration>>doc:Formcycle.Designer.Workflow.States.WebHome]] or [[access configuration>>doc:Formcycle.UserInterface.MyForms.Access.WebHome]] the option //Form records can be deleted// or //Form records deletable// needs to be activated in order for the form record to be deletable. If this is not the case the form record can not be deleted.
gru 1.1 214
sas 168.1 215 === General action ===
gru 1.1 216
sas 168.1 217 On the right side of the form record list header there are a number of //general actions// which are always available:
gru 1.1 218
sas 168.1 219 ==== {{ficon name="plus-circle-outline"/}} New form record ====
gru 1.1 220
sas 168.1 221 Opens up a menu through which existing forms may be called for submitting new form records.
gru 1.1 222
sas 168.1 223 ==== {{icon name="refresh"/}} Refresh ====
gru 1.1 224
sas 168.1 225 Refreshs the view.
gru 1.1 226
sas 168.1 227 ==== {{ficon name="view-rows"/}}/{{ficon name="view-columns"/}} Position of the review area ====
gru 1.1 228
sas 168.1 229 Toggles the position of the review area. The review area can be positioned at the right side or bottom of the window.
gru 1.1 230
sas 168.1 231 === Default view ===
gru 1.1 232
233 {{id name="inbox_list_default"/}}
234
sas 168.1 235 {{figure image="inbox_list_item_default_en.png"}}
gru 1.1 236 {{id name="fig_inbox_list_item_default" /}}
sas 168.1 237 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" /}}.
gru 1.1 238 {{/figure}}
239
240
sas 168.1 241 {{html wiki="true"}}
242 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
243 A form record in the default view: Clicking the inbox (in blue) sets an inbox filter. The attachment page of the form record can be accessed directly be clicking the paperclip icon .'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_list_item_default_en.png' width='300' group='$height' group='$group' title='
244 A form record in the default view: Clicking the inbox (in blue) sets an inbox filter. The attachment page of the form record can be accessed directly be clicking the paperclip icon .'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_list_item_default" /}}
245 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" /}}.</div></div></div>
246 {{/html}}
gru 1.1 247
sas 168.1 248
249 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"]].
250
251
jdr 42.1 252 {{id name="calendar-view"/}}
253
sas 168.1 254 === Calendar view ===
gru 1.1 255
sas 168.1 256 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"]].
gru 1.1 257
sas 168.1 258 === Project view ===
gru 1.1 259
260 {{id name="inbox_list_project"/}}
261
sas 168.1 262 {{figure image="inbox_project_view_en.png"}}
gru 1.1 263 {{id name="fig_inbox_project_view" /}}
sas 168.1 264 Form records in a project view. Project views can be displayed using the [[filter menu>>||anchor="filter_menu_view"]].
gru 1.1 265 {{/figure}}
266
sas 168.1 267 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.
gru 1.1 268
269 {{id name="export"/}}
270
sas 168.1 271 == Export ==
gru 1.1 272
sas 168.1 273 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"]]).
gru 1.1 274
sas 168.1 275 __Example:__
gru 1.1 276
sas 168.1 277 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.
gru 1.1 278
sas 168.1 279 There are three different types of exporting form records:
gru 1.1 280
281 === {{icon name="file-code-o"/}} XML ===
282
sas 168.1 283 {{figure image="inbox_export_xml_en.png"}}
gru 1.1 284 {{id name="fig_inbox_export_xml" /}}
sas 168.1 285 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.
gru 1.1 286 {{/figure}}
287
sas 168.1 288 Form record data of all form elements will be exported flat in an XML structure.
gru 1.1 289
290 {{code language="xml"}}
291 <xfc-data xfc-version="3.x.x" generation-date="yyyy-mm-dd HH:mm:ss.ms TZ">
292 <processes>
293 <process process-uid="xxx" creation-date="yyyy-mm-dd HH:mm:ss.ms TZ" project-name="yyy" status="zzz">
294 <form version="1">
295 <field name="elName">
296 <plainValue><![CDATA[Wert]]></plainValue>
297 <values count="1">
298 <value index="0"><![CDATA[]]></value>
299 </values>
300 <label><![CDATA[]]></label>
301 </field>
302 ...
303 </form>
304 <process ...>
305 </processes>
306 </xfc-data>
307 {{/code}}
308
sas 168.1 309 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]].
gru 1.1 310
311 === {{icon name="file-excel-o"/}} Excel ===
312
sas 168.1 313 {{figure image="inbox_export_excel_en.png"}}
gru 1.1 314 {{id name="fig_inbox_export_excel" /}}
sas 168.1 315 Excel export of the selected form records: Column names can be configured for every export. Additionally meta data may be exported.
gru 1.1 316 {{/figure}}
317
sas 168.1 318 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.Designer.Form.ElementProperties.BaseProperties.WebHome]] will be put into the same cell, separated by commas. If this is not desired the export option //Excel (multiline)// is recommended.
319 The column names of the resulting Excel file may configured using the following options:
gru 1.1 320
sas 168.1 321 * **Name of the form element**
322 The element names that are used in the [[{{designer/}}>>doc:Formcycle.Designer.Form.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns (e.g.: tf1, sel1, ...).
323 * **Alias of the form element**
324 The element alias that is used in the [[{{designer/}}>>doc:Formcycle.Designer.Form.ElementProperties.BaseProperties.WebHome]] will be used for the Excel columns.
325 * **Column name of the data table**
326 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"]].
gru 1.1 327
sas 168.1 328 === {{icon name="file-excel-o"/}} Excel (multiline) ===
gru 1.1 329
sas 168.1 330 {{info}}This Option is not available in [[project views>>||anchor="inbox_list_project"]].{{/info}}
331 The export works the exact same way as the simple Excel export, except that the values of [[repeated form elements>>Formcycle.Designer.Form.ElementProperties.BaseProperties.WebHome]] will be put into separate rows.
gru 1.1 332
sas 168.1 333 === Export meta data (Optional) ===
gru 1.1 334
sas 168.1 335 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:
gru 1.1 336
jdr 80.1 337 * **ID**
sas 168.1 338 System ID of the form record.
339 * **Process ID**
340 Process ID of the form record.
341 * **Subject**
342 Subject of the form record.
gru 1.1 343 * **Status**
sas 168.1 344 Name of the state the form record is in at the time of export.
345 * **Inbox**
346 * Inbox in which the form record is located.
347 * **Date of receipt**
348 Date the form record was submitted/created.
349 * **Modification date**
350 Date of last change to the form record.
351 * **Form variables**
352 Configured [[Form variables>>doc:Formcycle.Designer.Form.CodingPanel.VariablesTab]] an their values.
353 * **Control fields**
354 Control fields of the form such as //xf-action//, which holds the name of the button used for submitting the form.
355 * **Meta data**
356 Date of export and used FORMCYCLE version.
gru 1.1 357
sas 168.1 358 == Review area ==
gru 1.1 359
360 {{id name="review_area"/}}
sas 168.1 361 {{figure image="inbox_review_area_en.png"}}{{id name="fig_inbox_review_area" /}}
362 The review area of the inbox can be split into a (1) //header// and (2) //content// part.{{/figure}}
gru 1.1 363
jdr 90.1 364
sas 168.1 365 {{html wiki="true"}}
366 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
367 The review area of the inbox can be split into a (1) header and (2) content part.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_review_area_en.png' width='300' group='$height' group='$group' title='
368 The review area of the inbox can be split into a (1) header and (2) content part.'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_review_area" /}}
369 The review area of the inbox can be split into a (1) //header// and (2) //content// part.</div></div></div>
370 {{/html}}
gru 1.1 371
sas 168.1 372
373 Form records selected by a mouse click will be displayed in the review area of the inbox. Submitted form data can be reviewed here. Additionally a number of form record actions ma be performed. The review area consists of a //header// and //content// part (see [[figure>>||anchor="fig_inbox_review_area"]]).
374
gru 1.1 375 {{id name="review_area_header"/}}
sas 168.1 376 {{figure image="inbox_review_area_header_en.png"}}{{id name="fig_inbox_review_area_header" /}}
377 The header can be split into three rows: (1) //title row//, (2) //navigation row//, (3) //action row//.{{/figure}}
gru 1.1 378
jdr 90.1 379
sas 168.1 380 {{html wiki="true"}}
381 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='
382 The header can be split into three rows: (1) title row, (2) navigation row, (3) action row.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_review_area_header_en.png' width='300' group='$height' group='$group' title='
383 The header can be split into three rows: (1) title row, (2) navigation row, (3) action row.'/}}<div class='xm-figure-caption'>{{id name="fig_inbox_review_area_header" /}}
384 The header can be split into three rows: (1) //title row//, (2) //navigation row//, (3) //action row//.</div></div></div>
385 {{/html}}
gru 1.1 386
387
sas 168.1 388 The header is used for navigating the selected form record and performing form record actions. It consists of a //title row//, a //navigation row// and an //action row//. Depending on the selection in the navigation row different aspects of the form record will be displayed in the //content area//. Also the available form record actions in the action row change depending on the selection in the navigation row.
389
390 === Title row ===
391
392 {{figure image="inbox_review_area_header_expanded_en.png"}}
gru 1.1 393 {{id name="fig_inbox_review_area_header_expanded" /}}
sas 168.1 394 Clicking the expand icon {{icon name="chevron-down"/}} reveals further form record information: //form name//, //form record ID//, //process ID//, //review link//, //state//.
gru 1.1 395 {{/figure}}
396
sas 168.1 397 {{figure image="inbox_review_area_header_pages_en.png"}}
gru 1.1 398 {{id name="fig_inbox_review_area_header_pages" /}}
sas 168.1 399 All form pages can be accessed by clicking the expand icon {{icon name="chevron-down"/}} at the right side of the page tab.
gru 1.1 400 {{/figure}}
401
sas 168.1 402 The title row provides meta information about the form record. To the left is the form record subject in bold. To the right there are three buttons:
gru 1.1 403
404 * **{{icon name="chevron-down"/}} Details**
sas 168.1 405 Expands the title row to reveal further meta information about the form record (see [[figure>>||anchor="fig_inbox_review_area_header_expanded"]]).
406 * **{{ficon name="open-in-new"/}} Open in new tab**
407 Opens the current form record in a new tab.
408 * **{{ficon name="close-circle-outline"/}} Close**
409 Closes the review area.
gru 1.1 410
sas 168.1 411 === Navigation row ===
gru 1.1 412
sas 168.1 413 {{figure image="inbox_review_area_attachments_en.png"}}
414 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.
jdr 90.1 415 {{/figure}}
416
gru 1.1 417
sas 168.1 418 {{html wiki="true"}}
419 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='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.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_review_area_attachments_en.png' width='300' group='$height' group='$group' title='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.'/}}<div class='xm-figure-caption'>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.</div></div></div>
420 {{/html}}
jdr 90.1 421
gru 1.1 422
sas 168.1 423 {{id name="fig_inbox_review_area_attachments"/}}
424
425
426 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.
427
428 * **{{ficon name="XPage"/}} Form page**
429 Clicking this tab shows the filled out form. If the selected form consists of multiple pages the user can access in the current state, than an expand icon {{icon name="chevron-down"/}} appears on the right side of this tab. Different form pages can be accessed by clicking the icon. It is also possible to show all pages at once (see [[figure>>||anchor="fig_inbox_review_area_header_pages"]]).
430 {{info}}In some case not all pages should be displayed when clicking //All pages//. To allow this it is possible to set the attribute //force_summary_hiden// in the [[Designer>>Formcycle.Designer.Form.WebHome]] for elements that should be hidden.{{/info}}
431 This tab provides the following form record actions:
432 ** [[Trigger custom event>>||anchor="review_action_state_change"]]
433 ** {{icon name="save"/}} [[Save>>||anchor="review_action_save"]]
434 ** {{ficon name="trash-alt2"/}} [[Delete>>||anchor="review_action_delete"]]
435 ** {{ficon name="action-change-status"/}} [[Advanced options>>||anchor="review_action_advanced"]]
436 * **{{ficon name="table-large"/}} Datatable**
437 The submitted form record data will be displayed in a data table.
438 * **{{ficon name="history"/}} History**
439 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:
440 ** {{ficon name="plus-circle-outline"/}} [[Add entry>>||anchor="review_action_add_protocol_entry"]]
441 * **{{ficon name="paperclip-45"/}} Attachments**{{id name="review_area_attachments"/}}
442 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.Designer.Form.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.
443 ** {{ficon name="checkbox-marked-outline"/}} (De-)Selectionof all attachments
gru 1.1 444 ** {{icon name="download"/}} [[Download>>||anchor="review_action_download_attach"]]
sas 168.1 445 ** {{ficon name="trash-alt2"/}} [[Delete attachments>>||anchor="review_action_delete_attach"]]
gru 1.1 446
sas 168.1 447 === Action row ===
gru 1.1 448
sas 168.1 449 * **Trigger custom event**{{id name="review_action_state_change"/}}
450 Once one or more custom events exist in the workflow, it is possible to execute a custom event manually.
451 * **{{icon name="save"/}} Save**{{id name="review_action_save"/}}
452 Saves changes to the form data.
453 * **{{ficon name="trash-alt2"/}} Delete**{{id name="review_action_delete"/}}
454 Deletes the form record and closes the review area. Form records can only be deleted if the are in a state the allows for it (see [[access configuration>>Formcycle.UserInterface.MyForms.Access.WebHome]]).
455 * **{{ficon name="action-change-status"/}} Advanced options**{{id name="review_action_advanced"/}}
456 Opens up a dialog which allows for advanced form record changes:
457 ** //Correct form data//: Saves all changes to the form data with the option of (not) validating the form.
458 ** //Initiate workflow event//: [[A custom workflow event >>doc:Formcycle.Designer.Workflow.Events.Custom]]can be selected for manual execution.
459 * **{{ficon name="plus-circle-outline"/}} Add entry**{{id name="review_action_add_protocol_entry"/}}
460 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.
461 * **{{icon name="download"/}} Download attachments**{{id name="review_action_download_attach"/}}
462 Downloads the selected attachments.
463 * **{{ficon name="trash-alt2"/}} Delete attachments**{{id name="review_action_delete_attach"/}}
464 Deletes the selected attachments.