| ... |
... |
@@ -1,35
+1,79 @@ |
|
1 |
+{{figure image="form_inbox_en.png"}} |
|
2 |
+{{id name="fig_form_inbox_dialog" /}} |
|
3 |
+Inbox dialog of a form. |
|
4 |
+{{/figure}} |
|
5 |
+ |
| 1 |
1 |
{{content/}} |
| 2 |
2 |
|
| 3 |
|
-{{figure image="FCSnapshot9.png"}}Standard inbox with predefined columns{{/figure}} |
|
8 |
+The inbox dialog of a form can be opened via the //Inbox// button {{ficon name="inbox"/}} of the [[form menu>>doc:Formcycle.UserInterface.MyForms.WebHome||anchor="form_menu"]]. |
| 4 |
4 |
|
| 5 |
|
-{{figure image="formularpostfach_1.png"}}Form specific inbox with customizable columns{{/figure}} |
|
10 |
+== General settings == |
| 6 |
6 |
|
|
12 |
+* {{litem title="Subject"}}The subject of a form allows for naming of incoming [[form records>>doc:Terminology.WebHome||anchor="form_record"]]. [[Placeholders>>doc:Formcycle.UserInterface.Variables.WebHome]] can be used for the form subject. By Default the subject consist of the form title and the form record ID (//[%$PROJECT_TITLE%] - [%$RECORD_ID%]//).{{/litem}} |
|
13 |
+ |
|
14 |
+* {{litem title="Default inbox"}}All forms that have been submitted are put as form records in the inbox. If this setting has not been changed, all form records will be put into the system inbox //Default inbox//. This option allows you to change the inbox.{{/litem}} |
|
15 |
+ |
|
16 |
+* {{litem title="Allow state transitions in inbox"}}Whether users are allowed to perform state [[state>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.States.WebHome]] changes for form records of this form in the [[inbox>>doc:Formcycle.UserInterface.MyForms.Inbox]].{{/litem}} |
|
17 |
+ |
| 7 |
7 |
The standard inbox contains form records of different forms always shows certain fixed columns, ie. project ID, form record ID, process ID, date of submission, date of most recent change, and state. Form records may also be viewed in their own form-specific inbox with customizable columns. |
| 8 |
8 |
|
| 9 |
|
-== Database table == |
|
20 |
+== Configuring form specific inboxes == |
| 10 |
10 |
|
| 11 |
|
-After a form has been submitted, all submitted data will be stored in a database table of the system. For the standard inbox, the system will generate the view with the columns available, which may depend on the user's permissions, the form's state and the inbox. |
|
22 |
+{{figure image="inbox_project_view_en.png"}} |
|
23 |
+Project specific view selected in the [[inbox>>doc:Formcycle.Inbox.WebHome]]. |
|
24 |
+{{/figure}} |
| 12 |
12 |
|
| 13 |
|
-For the form specific inbox, the system dynamically creates one more database tables for each form. It contains the custom columns as configured for each form. |
| 14 |
14 |
|
| 15 |
|
-{{figure image="pr_postfach_normal_en.png"}}Standard inbox.{{/figure}} |
|
27 |
+{{html wiki="true"}} |
|
28 |
+<div class='xm-figure xm-float-right xm-clear-global' data-alt='Project specific view selected in the inbox.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='inbox_project_view_en.png' width='300' group='$height' group='$group' title='Project specific view selected in the inbox.'/}}<div class='xm-figure-caption'>Project specific view selected in the [[inbox>>doc:Formcycle.Inbox.WebHome]].</div></div></div> |
|
29 |
+{{/html}} |
| 16 |
16 |
|
| 17 |
|
-{{figure image="pr_postfach_projekt_en.png" width="300"}}For form specific inboxes, the system stores a separate table with the inbox configuration.{{/figure}} |
| 18 |
18 |
|
| 19 |
|
-== Configuring form specific inboxes == |
|
32 |
+{{figure image="pr_postfach_normal_en.png"}} |
|
33 |
+Standard inbox. |
|
34 |
+{{/figure}} |
| 20 |
20 |
|
| 21 |
|
-{{figure image="084En.png"/}} |
| 22 |
22 |
|
| 23 |
|
-Open the form and go to the section //inbox//. |
|
37 |
+{{html wiki="true"}} |
|
38 |
+<div class='xm-figure xm-float-right xm-clear-global' data-alt='Standard inbox.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='pr_postfach_normal_en.png' width='300' group='$height' group='$group' title='Standard inbox.'/}}<div class='xm-figure-caption'>Standard inbox.</div></div></div> |
|
39 |
+{{/html}} |
| 24 |
24 |
|
| 25 |
|
-The list on the right hand side shows all form fields available for the current version of the form. The list on the left hand side shows all columns that will be shown in the custom inbox for this form. Use the buttons between the two lists to move form fields between the two lists. |
| 26 |
26 |
|
| 27 |
|
-===Column alias=== |
|
42 |
+{{figure image="pr_postfach_projekt_en.png" width="300"}} |
|
43 |
+For form specific inboxes, the system stores a separate table with the inbox configuration. |
|
44 |
+{{/figure}} |
| 28 |
28 |
|
| 29 |
|
-An alias can be set for form field in the list on the left hand side by clicking on the edit icon. When an alias has been set, it will be used as the column name of instead of the form field's name. |
| 30 |
30 |
|
| 31 |
|
-===Reinitialise inbox=== |
|
47 |
+{{html wiki="true"}} |
|
48 |
+<div class='xm-figure xm-float-right xm-clear-global' data-alt='For form specific inboxes, the system stores a separate table with the inbox configuration.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='pr_postfach_projekt_en.png' width='300' group='$height' group='$group' title='For form specific inboxes, the system stores a separate table with the inbox configuration.'/}}<div class='xm-figure-caption'>For form specific inboxes, the system stores a separate table with the inbox configuration.</div></div></div> |
|
49 |
+{{/html}} |
| 32 |
32 |
|
| 33 |
|
-This will read the current inbox settings and recreate the dynamically created database table. This makes it possible to change view of the custom inbox at any time. |
| 34 |
34 |
|
| 35 |
|
-This button is available only after a custom inbox has been saved at least once. |
|
52 |
+The defualt view of the [[inbox>>doc:Formcycle.Inbox.WebHome]] shows all [[form records>>doc:Terminology.WebHome||anchor="form_record"]] the user has access to. This depends on the [[State>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.States.WebHome]] of the [[form record>>doc:Terminology.WebHome||anchor="form_record"]], the [[groups>>doc:Formcycle.UserInterface.UserSettings.UserGroups.WebHome]] the user is in and the set filters of the inbox. |
|
53 |
+ |
|
54 |
+Alternatively a "Form-specific data view in the mailbox" for the form can be defined by configuring the columns that should be displayed. |
|
55 |
+ |
|
56 |
+The list at the bottom of the inbox dialog shows the configuration of the form inbox view. The list on the right hand side shows all form fields available for the current version of the form. The list on the left hand side shows all columns that will be shown in the custom inbox for this form. Use the buttons between the two lists to move form fields between the two lists. |
|
57 |
+ |
|
58 |
+As soon as a user in the inbox gains access to tasks of this form, an additional option to display the view configured here will appear. |
|
59 |
+ |
|
60 |
+{{version major="6" minor="4" patch="0"/}} Starting with {{formcycle/}} version 6.4.0 technical elemente like //ID//, //Subject// and //Inbox// can be shown or hidden as required. To differentiate between normal form elements, which have {{ficon name="inbox"/}} symbols in front of their names in this dialog, technical elements are marked by a {{ficon name="settings2"/}} symbol. |
|
61 |
+ |
|
62 |
+=== Database tables === |
|
63 |
+ |
|
64 |
+After a form has been submitted, all submitted data will be stored in a database table of the system. For the standard inbox, the system will generate the view with the columns available, which may depend on the user's permissions, the form's state and the inbox. |
|
65 |
+ |
|
66 |
+For the form specific inbox, the system dynamically creates one more database tables for each form. It contains the custom columns as configured for each form. |
|
67 |
+ |
|
68 |
+=== Column alias === |
|
69 |
+ |
|
70 |
+{{info}} |
|
71 |
+Please note that the column alias is different from the form field alias. Initially, when you create a new inbox configuration, the column alias is set to the form field alias. When you later change the form field alias, the column alias is not updated automatically. |
|
72 |
+{{/info}} |
|
73 |
+ |
|
74 |
+An alias can be set for form field in the list on the left hand side by clicking on the edit icon. When an alias has been set, it will be used as the column name of instead of the form field's name. |
|
75 |
+ |
|
76 |
+=== Reinitialise inbox === |
|
77 |
+ |
|
78 |
+Have changes been made to the inbox view configuration, clicking the //Save// {{icon name="save"/}} or //Reinitialize// {{icon name="refresh"/}} button will (re-)intialize the form inbox table. |
|
79 |
+This will read the current inbox settings and recreate the dynamically created database table. This makes it possible to change view of the custom inbox at any time. Depending on the number of form records this may take several minutes. |