document some of the more obscure features
This commit is contained in:
parent
de67f1ba72
commit
65b2887f9f
|
@ -0,0 +1,11 @@
|
||||||
|
(process_error_handling)=
|
||||||
|
# Process Error Handling
|
||||||
|
|
||||||
|
What happens when a process model errors?
|
||||||
|
The system will capture the error and cause a process model to run.
|
||||||
|
In order to get started, simply create a process model that includes a message start event that handles messages with the name `SystemErrorMessage`.
|
||||||
|
You can use this process model to handle the error in whatever way is most helpful for you.
|
||||||
|
|
||||||
|
Process models often have ways to communicate with users--using an email connector if you use email or using a slack connector if you use slack, etc--and you can use these same capabilities to inform the appropriate users when an error occurs.
|
||||||
|
You can decide to ignore errors that occur in less important models and you can escalate errors in other models to the CEO.
|
||||||
|
Since you are using a process model, you have all of the power you need to handle errors in the way that matches your business requirements.
|
|
@ -82,8 +82,8 @@ The new Process Groups tile will be available under the Process Groups view.
|
||||||
- Identifier: Enter a unique identifier for the process model.
|
- Identifier: Enter a unique identifier for the process model.
|
||||||
- Description: Provide a brief description of the process model, outlining its purpose or functionality.
|
- Description: Provide a brief description of the process model, outlining its purpose or functionality.
|
||||||
- Notification Type: Specify the type of notification related to the process model.
|
- Notification Type: Specify the type of notification related to the process model.
|
||||||
- Notification Address: Enter the address or destination where the notification should be sent.
|
- Notification Addresses: Enter the addresses or destinations where notifications should be sent in the event that a process instance encounters an error. You do not need to worry about setting these values unless you are interested in custom {ref}`process_error_handling`.
|
||||||
- Metadata Extraction Path: Specify the key and path or location where metadata extraction should occur within the process model.
|
- Metadata Extraction Path: You can provide one or more metadata extractions to uplift data from your process instances to provide quick access in searches and perspectives. Specify the key and path/location where metadata extraction should occur within the process model. For example, if you have a script task that runs the statement `great_color = "blue"`, then you would set extraction path to `great_color`. You would probably also set extraction key to `great_color`. But if you wanted to, you could just call it `color`, assuming you wanted that to be the name used in reports, etc.
|
||||||
|
|
||||||
Make sure to accurately fill in all the required fields in the Process Model form to ensure proper configuration and functionality.
|
Make sure to accurately fill in all the required fields in the Process Model form to ensure proper configuration and functionality.
|
||||||
|
|
||||||
|
|
|
@ -26,6 +26,7 @@ Building_Diagrams/dmn.md
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:caption: Debugging Diagrams
|
:caption: Debugging Diagrams
|
||||||
Debugging_Diagrams/bpmn_unit_tests.md
|
Debugging_Diagrams/bpmn_unit_tests.md
|
||||||
|
Debugging_Diagrams/process_error_handling.md
|
||||||
```
|
```
|
||||||
|
|
||||||
```{toctree}
|
```{toctree}
|
||||||
|
|
Loading…
Reference in New Issue