Wiki source code of Status
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{content/}} | ||
| 2 | |||
| 3 | == Overview == | ||
| 4 | |||
| 5 | Depending on the state of a submitted form, also called a form record, different [[actions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] are executed by the system such as sending mails or creating pdf files. | ||
| 6 | |||
| 7 | Form records can also be sorted by their state in the [[inbox>>Formcycle.Inbox]]. | ||
| 8 | |||
| 9 | To illustrate, consider a survey form for which the states //Received//, //In progress//, //Incorrect answers//, and //Done// might have been created. | ||
| 10 | |||
| 11 | == System state received == | ||
| 12 | |||
| 13 | The special system state //Received// cannot be deleted and will always be created when a new form is created. After a form has been submitted by the user, this is always the first state of the form record. | ||
| 14 | |||
| 15 | == State settings == | ||
| 16 | |||
| 17 | {{id name="fig_state_new"/}} | ||
| 18 | {{figure image="state_new_en.png"}}Adding a new state.{{/figure}} | ||
| 19 | |||
| 20 | Open the workflow of the desired form via the [[form menu>>Formcycle.UserInterface.MyForms||anchor="form_menu"]]. A new state will be added by clicking the "New" button {{ficon name="plus-circle-outline"/}} above the state list (see [[figure>>||anchor="fig_state_new"]]). | ||
| 21 | |||
| 22 | === Base settings === | ||
| 23 | |||
| 24 | * **Name** | ||
| 25 | An arbitrary name for this state that is also displayed in the [[Inbox>>Formcycle.Inbox]], eg. //Archive form record//. | ||
| 26 | * **Identifier** | ||
| 27 | The identifier will be displayed as the current state of the form record in the inbox, eg. //Form record archived//. | ||
| 28 | * **Error handling** | ||
| 29 | Choose what will happen when an error has occurred while processing the form or certain [[actions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]]. | ||
| 30 | ** //change state anyway// | ||
| 31 | A state transition will be performed irrespective of whether any errors have occurred. | ||
| 32 | ** //do not change state// | ||
| 33 | The state will not change when an error has occurred. When this option is selected for the system state //Received//, submitted forms will not be saved and shown in the inbox when an error occurs in an action executed immediately after the form was submitted. | ||
| 34 | * **Description** | ||
| 35 | optional | ||
| 36 | |||
| 37 | === Access === | ||
| 38 | |||
| 39 | * **User groups that may set this state** | ||
| 40 | Only users belong to one of the checked user groups may perform a transition to this state. This option is not available for the special system state //Received//. | ||
| 41 | * **Allowed source states for transitions to this state** | ||
| 42 | You can setup the workflow to be linear (one state after the next) or non-linear (complex state transitions). You can choose which state should be available after which states. In the inbox, users may only perform state transitions to state that are available after the current states. | ||
| 43 | |||
| 44 | {{lightbox image="status_liner.png"/}} | ||
| 45 | |||
| 46 | * **Form records can be deleted** | ||
| 47 | When this option is checked, form records in this state can be deleted by users in the [[Inbox>>Formcycle.Inbox]]. | ||
| 48 | * **Allow unregistered review** | ||
| 49 | {{version major="6" minor="6" patch="0"}}Since version 6.6.0 this option is called //In this status, the form can be opened without user login via the form-process-link//{{/version}}. | ||
| 50 | If this option is enabled, form records in this state can be displayed to anonymous users. | ||
| 51 | (Prerequisite for the display is the knowledge of the URL to the form, indicating the corresponding process-ID) | ||
| 52 | If the option is disabled, form records in this state are only visible to authenticated {{formcycle/}} users. | ||
| 53 | * **State after resubmission** | ||
| 54 | Marks this state as the //resubmission state//. A form record goes into the state of resubmission when a previously submitted form is submitted again (e.g. in the [[inbox>>Formcycle.Inbox]]). Usually it is not desired that the entire workflow processing is triggered starting with the state //Received//. By defaulft the //resubmission state// is the state //Received//. | ||
| 55 | |||
| 56 | === Timed state transition === | ||
| 57 | |||
| 58 | You can set a time limit after which form records in this state are automatically moved to another state. By default, this option is set to 0, which disables timed status transitions. | ||
| 59 | |||
| 60 | This can be used to perform certain scheduled actions or as a means of [[escalating issues>>Formcycle.UserInterface.MyForms.WorkflowProcessing.States.EscalatingIssues]]. |