From 65b2887f9faba51ccc92eb6f5df7557ef77bd513 Mon Sep 17 00:00:00 2001 From: burnettk Date: Tue, 22 Aug 2023 23:30:02 -0400 Subject: [PATCH] document some of the more obscure features --- docs/Debugging_Diagrams/process_error_handling.md | 11 +++++++++++ .../admin_and_permissions.md | 4 ++-- docs/index.md | 1 + 3 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 docs/Debugging_Diagrams/process_error_handling.md diff --git a/docs/Debugging_Diagrams/process_error_handling.md b/docs/Debugging_Diagrams/process_error_handling.md new file mode 100644 index 000000000..97412aa33 --- /dev/null +++ b/docs/Debugging_Diagrams/process_error_handling.md @@ -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. diff --git a/docs/DevOps_installation_integration/admin_and_permissions.md b/docs/DevOps_installation_integration/admin_and_permissions.md index d76a8c9f0..6d89c43d4 100644 --- a/docs/DevOps_installation_integration/admin_and_permissions.md +++ b/docs/DevOps_installation_integration/admin_and_permissions.md @@ -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. - 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 Address: Enter the address or destination where the notification should be sent. -- Metadata Extraction Path: Specify the key and path or location where metadata extraction should occur within the process model. +- 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: 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. diff --git a/docs/index.md b/docs/index.md index 8b19f14cb..9a5b21927 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,6 +26,7 @@ Building_Diagrams/dmn.md :maxdepth: 1 :caption: Debugging Diagrams Debugging_Diagrams/bpmn_unit_tests.md +Debugging_Diagrams/process_error_handling.md ``` ```{toctree}