From version < 2.1 >
edited by gru
on 13.03.2019, 11:32
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
Title
... ... @@ -1,1 +1,1 @@
1 -$services.localization.render("PT.Main.Inbox")
1 +Inbox
Content
... ... @@ -1,135 +1,243 @@
1 1  {{content/}}
2 2  
3 +
3 3  == Description ==
4 4  
5 -In the Inbox, depending on the authorization, all received transactions (received form data) are clearly displayed in the so-called aggregate or form mailboxes. It is also possible to change the state of an operation, to upload files and to write comments.
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.
6 6  
7 -== Aggregate mailbox ==
8 +== Structure ==
8 8  
9 -This type of mailbox contains operations of several forms.
10 +{{figure image="inbox_overview_marked_en.png"}}
11 +{{id name="fig_inbox_overview" /}}
12 +The inbox consists of (1) the //filter menu//, (2) the //form record list// and (3) the //review area//.
13 +{{/figure}}
10 10  
11 -{{figure image="045En.png"/}}
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.
12 12  
17 +== Filter menu ==
13 13  
14 -== Form mailbox ==
19 +{{id name="filter_menu"/}}
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:
15 15  
16 -This type of mailbox contains operations of a form.
22 +=== Search ===
17 17  
18 -{{figure image="FCSnapshot33.png" group="inbox"/}}
24 +{{figure image="inbox_filter_menu_search_type_en.png"}}
25 +{{id name="fig_inbox_filter_menu_search_type" /}}
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.
27 +{{/figure}}
19 19  
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:
20 20  
21 -=== Opening the operation ===
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.
22 22  
23 -An operation is opened by double-clicking on the corresponding entry.
42 +No search filter is being applied if the input field is empty. In project views the input field is not being displayed.
24 24  
25 -{{figure image="046En.png" width="500"/}}
44 +=== View ===
26 26  
27 -=== Searching, filtering and sorting ===
46 +{{id name="filter_menu_view"/}}
47 +{{figure image="inbox_filter_menu_view_en.png"}}{{id name="fig_inbox_filter_menu_view" /}}
48 +There are two different types of views, which can be differentiated by their symbols {{ficon name="view-list"/}}/{{ficon name="layout-table"/}}: (1) the //default view// of form records and (2) the //project views// (marked in red).{{/figure}}
28 28  
29 -{{figure image="047En.png" width="400" group="inbox"/}}
50 +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:
30 30  
52 +* {{ficon name="view-list"/}} **Default**
53 +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"]].
54 +* {{ficon name="layout-table"/}} **Project views**
55 +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"]]).
31 31  
32 -==== Searching ====
57 +=== Filter ===
33 33  
34 -The search always refers to a column. The column to be searched will appear as a placeholder in the search box. To select another column, click on the magnifying glass in the search field.
59 +{{figure image="inbox_filter_menu_filter_en.png"}}{{id name="fig_inbox_filter_menu_filter" /}}
60 +Filter: There are four quick filters available.{{/figure}}
61 +There are four quick filters available for configuring the form record list.
35 35  
36 -Resetting the search is done using the "x" at the right edge of the search field.
63 +* **Show all**
64 +All form records of the current [[view>>doc:||anchor="filter_menu_view"]] will be displayed.
65 +* **Recently edited**
66 +All form records that have been edited in the past 14 days will be displayed.
67 +* **Edited by me**
68 +All form records that have been edited by the current [[user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] will be displayed.
69 +* **Created by me**
70 +All form records that have been created by the current [[user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] will be displayed.
37 37  
38 -{{figure image="048En.png" height="150" group="inbox"/}}
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.
39 39  
76 +=== Inboxes ===
40 40  
41 -==== Filtering ====
78 +{{id name="filter_menu_inboxes"/}}
42 42  
43 -The following filters are available in the toolbar.
80 +{{figure image="inbox_filter_menu_inboxes_en.png"}}
81 +{{id name="fig_inbox_filter_menu_inboxes" /}}
82 +Only form records within the selected inboxes will be displayed.
83 +{{/figure}}
44 44  
45 -**Eye icon**
85 +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.
46 46  
47 -Only shows processes, that are unread.
87 +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.
48 48  
89 +=== Submit date ===
49 49  
50 -**Week**
91 +{{figure image="inbox_filter_menu_date_en.png"}}
92 +{{id name="fig_inbox_filter_menu_date" /}}
93 +The form record list can be filtered by submit date.
94 +{{/figure}}
51 51  
52 -Only shows processes from the current week.
96 +The form record list can be filtered by the submit date of the form records. For this there are two input fields available:
53 53  
54 -**Period**
98 +* **from**
99 +All form records submitted from the given date will be displayed.
100 +* **until**
101 +All form records submitted until the given date will be displayed.
55 55  
56 -Only Shows events from the selected period.
103 +No submit date filter will be applied if these fileds are empty.
57 57  
58 -**Reset**
105 +=== Sorting ===
59 59  
60 -Resets the filters, so that all operations are displayed again.
107 +{{figure image="inbox_filter_menu_sort_en.png"}}
108 +{{id name="fig_inbox_filter_menu_sort" /}}
109 +The default view of the form record list can be sorted by different criteria.
110 +{{/figure}}
61 61  
112 +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:
62 62  
63 -==== Sorting ====
114 +* **Submit date**
115 +* **Last change date**
116 +* **Subject**
117 +* **State**
64 64  
65 -For sorting, simply click the appropriate column heading. The column indicating the sorting and the sorting direction is represented by a small triangle in the column header.
119 +=== More filters ===
66 66  
67 -=== Advanced view of an operation ===
121 +{{figure image="inbox_filter_menu_others_en.png"}}
122 +{{id name="fig_inbox_filter_menu_others" /}}
123 +More filters for individual searches.
124 +{{/figure}}
68 68  
69 -The expanded view is opened using the plus icon ((% style="color: rgb(0, 0, 0);" %)+)(%%) at the beginning of the line of the appropriate process.
126 +More filters are provided for further refinement of the search:
70 70  
71 -{{figure image="049En.png" width="400" group="inbox"/}}
128 +* **(Un-)Read**
129 +Only (un-)read form records will be displayed.
130 +* **With/Without attachment**
131 +Only form records with/without attachments will be displayed.
132 +* **(Not) Saved**
133 +Only form records that are (not) saved will be displayed.
134 +* **(No) Double-Opt-In**
135 +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).
72 72  
137 +== Form record list ==
73 73  
74 -==== Changing state ====
139 +{{id name="inbox_list"/}}
140 +{{figure image="inbox_list_default_marked_en.png"}}{{id name="fig_inbox_list_default_marked" /}}
141 +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}}
75 75  
76 -To change the state, go to the advanced view. Depending on the authorization, the state tab is available for the current process. In addition to the state change, a comment may also be added or a file uploaded.
143 +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"]].
144 +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.
145 +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//.
77 77  
78 -Each of these actions is logged in the transaction history.
147 +{{id name="form_record_actions"/}}
79 79  
80 -(% style="line-height: 1.4em;" %)Should there be no available state for the state change, this may have the following causes.
149 +=== Form record actions ===
81 81  
82 -* //No state availabale// The selected process, in its current state, has no subsequent state.
151 +Which form record actions will be displayed depends on the currently selected form records.
83 83  
84 -* //State change not allowed// The form settings were defined so that no state change for operations of this form can be achieved by the current user.
153 +==== {{ficon name="checkbox-marked-outline"/}} Select all form records ====
85 85  
86 -{{figure image="050En.png" width="400" group="inbox"/}}
155 +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.
87 87  
157 +==== {{icon name="download"/}} Export ====
88 88  
89 -==== Uploading a file to the operation ====
159 +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.
90 90  
91 -To add a file to the operation, open the advanced view and paste the file in the //file// field. Several files can be added simultaneously.
161 +For further information on form record export see [[Export>>||anchor="export"]].
92 92  
93 -This action is logged in the transaction history.
163 +==== {{ficon name="action-move-inbox"/}} Move ====
94 94  
95 -{{figure image="051En.png" height="150" group="inbox"/}}
165 +{{figure image="inbox_move_en.png"}}
166 +{{id name="fig_inbox_move" /}}
167 +Moves the selected form records to a different inbox.
168 +{{/figure}}
96 96  
170 +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.
97 97  
98 -==== History ====
172 +==== {{icon name="envelope"/}}/{{icon name="envelope-open"/}} (Un-)Read ====
99 99  
100 -All actions or changes in the operation are shown in the history.
174 +Clicking the //Read// or //Unread// button markes the selected form records as read or unread.
101 101  
102 -{{figure image="052En.png" height="150" group="inbox"/}}
176 +==== {{ficon name="trash-alt2"/}} Delete ====
103 103  
178 +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.UserInterface.MyForms.WorkflowProcessing.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.
104 104  
105 -==== Setting the operation to unread ====
180 +=== General action ===
106 106  
107 -After an operation has been opened, it will be marked as read and the font changes from //bold// to //normal//.
182 +On the right side of the form record list header there are a number of //general actions// which are always available:
108 108  
109 -In the case of filtering for unread operations, this operation will not be displayed any longer. To reset an operation back to //unread//, switch to the advanced view and select the checkbox //set operation unread//.
184 +==== {{ficon name="plus-circle-outline"/}} New form record ====
110 110  
111 -This action is logged in the transaction history.
186 +Opens up a menu through which existing forms may be called for submitting new form records.
112 112  
113 -{{figure image="053En.png" height="150" group="inbox"/}}
188 +==== {{icon name="refresh"/}} Refresh ====
114 114  
190 +Refreshs the view.
115 115  
116 -==== Exporting ====
192 +==== {{ficon name="view-rows"/}}/{{ficon name="view-columns"/}} Position of the review area ====
117 117  
118 -By selecting //export//, the currently selected operations or all operations, if no operation is selected, can be exported from the corresponding mailbox.
194 +Toggles the position of the review area. The review area can be positioned at the right side or bottom of the window.
119 119  
120 -{{figure image="054En.png" height="150" group="inbox"/}}
196 +=== Default view ===
121 121  
122 -{{figure image="055En.png" height="150" group="inbox"/}}
198 +{{id name="inbox_list_default"/}}
123 123  
200 +{{figure image="inbox_list_item_default_en.png"}}{{id name="fig_inbox_list_item_default" /}}
201 +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}}
202 +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"]].
124 124  
125 -Two options are available for the exported operations:
204 +{{id name="calendar-view" /}}
205 +=== Calendar view {{version major="6" minor="5" patch="0"/}} ===
126 126  
127 -===== XML =====
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"]].
128 128  
129 -__//Standard without XSL template~://__
209 +=== Project view ===
130 130  
131 -The form data (all the form elements) are exported as a flat XML structure.
211 +{{id name="inbox_list_project"/}}
132 132  
213 +{{figure image="inbox_project_view_en.png"}}
214 +{{id name="fig_inbox_project_view" /}}
215 +Form records in a project view. Project views can be displayed using the [[filter menu>>||anchor="filter_menu_view"]].
216 +{{/figure}}
217 +
218 +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.
219 +
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 +
133 133  {{code language="xml"}}
134 134  <xfc-data xfc-version="3.x.x" generation-date="yyyy-mm-dd HH:mm:ss.ms TZ">
135 135   <processes>
... ... @@ -149,49 +149,135 @@
149 149  </xfc-data>
150 150  {{/code}}
151 151  
152 -__//Standard with XSL template~://__
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]].
153 153  
154 -{{figure image="056En.png" height="150" group="inbox"/}}
262 +=== {{icon name="file-excel-o"/}} Excel ===
155 155  
156 -Using an XSL template, the exported XML can be transformed into the required target format. The corresponding template can be selected via the selection list. See also [[Create XSL template>>doc:XSLTranMenue]].
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}}
157 157  
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:
158 158  
159 -===== Excel =====
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"]].
160 160  
161 -All data is exported to an Excel file. Should there be several operations in the mailbox, a separate worksheet is created in the Excel file for each form project.
279 +=== {{icon name="file-excel-o"/}} Excel (multiline) ===
162 162  
163 -__//**What is exported when?**//__
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.
164 164  
165 -If operations were selected, only these will be exported. If no operations were selected, all currently visible operations are exported.
284 +=== Export meta data (Optional) ===
166 166  
167 -Example:
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:
168 168  
169 -The mailbox contains a total of 1000 operations. After a search or a filtering only 500 operations are displayed. If no operations are selected, only these 500 visible operations will be exported. To export the 1000 operations, all searches and filters need to be reset.
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.
170 170  
310 +== Review area ==
171 171  
172 -==== Operation / delete operations ====
312 +{{id name="review_area"/}}
313 +{{figure image="inbox_review_area_en.png"}}{{id name="fig_inbox_review_area" /}}
314 +The review area of the inbox can be split into a (1) //header// and (2) //content// part.{{/figure}}
173 173  
174 -An operation can only be deleted if it is in a state that allows this. In the administration of the [[state processing>>doc:Statusliste]] the option //operations can be deleted in this state// must be activated. If this is not the case, the operation cannot be deleted. Whether it is possible to delete the operation can be seen at the cross icon ((% style="color: rgb(255, 0, 0);" %)x(%%)).
316 +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"]]).
175 175  
176 -{{figure image="057En.png" height="150" group="inbox"/}}
318 +{{id name="review_area_header"/}}
319 +{{figure image="inbox_review_area_header_en.png"}}{{id name="fig_inbox_review_area_header" /}}
320 +The header can be split into three rows: (1) //title row//, (2) //navigation row//, (3) //action row//.{{/figure}}
177 177  
322 +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.
178 178  
179 -===== Deleting multiple operations =====
324 +=== Title row ===
180 180  
181 -To delete several operations simultaneously, the corresponding operations can me marked and deleted using the //delete// option. Processes that cannot be deletet, won't be deleted. After completion of the deletion, the actual number of deleted transactions will be displayed.
326 +{{figure image="inbox_review_area_header_expanded_en.png"}}
327 +{{id name="fig_inbox_review_area_header_expanded" /}}
328 +Clicking the expand icon {{icon name="chevron-down"/}} reveals further form record information: //form name//, //form record ID//, //process ID//, //review link//, //state//.
329 +{{/figure}}
182 182  
183 -{{figure image="058En.png" height="150" group="inbox"/}}
331 +{{figure image="inbox_review_area_header_pages_en.png"}}
332 +{{id name="fig_inbox_review_area_header_pages" /}}
333 +All form pages can be accessed by clicking the expand icon {{icon name="chevron-down"/}} at the right side of the page tab.
334 +{{/figure}}
184 184  
336 +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:
185 185  
186 -==== Operation / shifting operations ====
338 +* **{{icon name="chevron-down"/}} Details**
339 +Expands the title row to reveal further meta information about the form record (see [[figure>>||anchor="fig_inbox_review_area_header_expanded"]]).
340 +* **{{ficon name="open-in-new"/}} Open in new tab**
341 +Opens the current form record in a new tab.
342 +* **{{ficon name="close-circle-outline"/}} Close**
343 +Closes the review area.
187 187  
188 -One or more selected operations can be moved to another mailbox. During a displacement of operations, no action of the operation state is performed. Moving is possible only by using the menu, drag&drop is not supported here.
345 +=== Navigation row ===
189 189  
190 -{{figure image="059En.png" height="150" group="inbox"/}}
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"/}}
191 191  
350 +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.
192 192  
193 -==== Showing and hiding columns ====
352 +* **{{ficon name="XPage"/}} Form page**
353 +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"]]).
354 +{{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.FormDesigner.WebHome]] for elements that should be hidden.{{/info}}
355 +This tab provides the following form record actions:
356 +** [[State change>>||anchor="review_action_state_change"]]
357 +** {{icon name="save"/}} [[Save>>||anchor="review_action_save"]]
358 +** {{ficon name="trash-alt2"/}} [[Delete>>||anchor="review_action_delete"]]
359 +** {{ficon name="action-change-status"/}} [[Advanced options>>||anchor="review_action_advanced"]]
360 +* **{{ficon name="table-large"/}} Datatable**
361 +The submitted form record data will be displayed in a data table.
362 +* **{{ficon name="history"/}} History**
363 +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:
364 +** {{ficon name="plus-circle-outline"/}} [[Add entry>>||anchor="review_action_add_protocol_entry"]]
365 +* **{{ficon name="paperclip-45"/}} Attachments**{{id name="review_area_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.
367 +** {{ficon name="checkbox-marked-outline"/}} (De-)Selectionof all attachments
368 +** {{icon name="download"/}} [[Download>>||anchor="review_action_download_attach"]]
369 +** {{ficon name="trash-alt2"/}} [[Delete attachments>>||anchor="review_action_delete_attach"]]
194 194  
195 -The columns in the current view can be switched on and be hidden as required.
371 +=== Action row ===
196 196  
197 -{{figure image="060.png" height="150" group="inbox"/}}
373 +* **State change**{{id name="review_action_state_change"/}}
374 +Saves changes in the form data, changes the state of the form record and executes the actions of the selected state. This action is only available if the state can be changed by the user. The state can only be changed if:
375 +** the current state of the selected form record has a follow-up state.
376 +** the user is allowed to change the state (can be configured in the [[workflow>>Formcycle.UserInterface.MyForms.WorkflowProcessing.WebHome]]).
377 +* **{{icon name="save"/}} Save**{{id name="review_action_save"/}}
378 +Saves changes to the form data.
379 +* **{{ficon name="trash-alt2"/}} Delete**{{id name="review_action_delete"/}}
380 +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]]).
381 +* **{{ficon name="action-change-status"/}} Advanced options**{{id name="review_action_advanced"/}}
382 +Opens up a dialog which allows for advanced form record changes:
383 +** //Correct form data//: Saves all changes to the form data with the option of (not) validating the form.
384 +** //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.
385 +** //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.
386 +* **{{ficon name="plus-circle-outline"/}} Add entry**{{id name="review_action_add_protocol_entry"/}}
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.
388 +* **{{icon name="download"/}} Download attachments**{{id name="review_action_download_attach"/}}
389 +Downloads the selected attachments.
390 +* **{{ficon name="trash-alt2"/}} Delete attachments**{{id name="review_action_delete_attach"/}}
391 +Deletes the selected attachments.
Copyright 2000-2024