mirror of
https://github.com/status-im/spiff-arena.git
synced 2025-02-28 01:10:37 +00:00
963d62b323
* let us proof everything * proof and ventilate everything * restore removed content * add back in some headers * add back more headers * restore header * fix header * fix backend * restore two long files from main to avoid mangling * update edit_all for testing * fix docs * notes * more spacing --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
140 lines
5.1 KiB
Markdown
140 lines
5.1 KiB
Markdown
# Suspend, Resume, and Terminate a Process
|
||
|
||
| ⚙ How do I get there \| Menu Hierarchy |
|
||
| -------------------------------------- |
|
||
| Follow steps to find a process instance |
|
||
|
||
## Suspend a Process
|
||
|
||
By suspending a process instance, you temporarily halt its execution, allowing you to access and modify the necessary data or configurations associated with that specific instance.
|
||
This feature is not only useful for making updates, but also enables the possibility to redo a previous step with different metadata if needed.
|
||
|
||
> **Step 1: Find the Active Process Instance**
|
||
|
||
- In order to locate the active process instance, have a look at these pages to find an instance to suspend.
|
||
|
||
```{admonition} Note
|
||
|
||
⚠ Note that the suspension of a process instance is only applicable to active instances.
|
||
If an instance is not active, it indicates that the process has already been completed, and therefore, it cannot be suspended.
|
||
|
||
```
|
||
|
||
> **Step 2: Locate Suspend Icon**
|
||
|
||
|
||
|
||
- Next to the Process Instance Id, look for the icon that resembles the 'Suspend' icon and select it to initiate the suspension of the process instance.
|
||
|
||
> **Step 3: Select Suspend Button**
|
||
|
||
Click on the 'Suspend' icon.
|
||
This action will pause the process instance, granting you the ability to make edits and modifications.
|
||
When ready, the process instance can be resumed.
|
||
The process instance remains highlighted in yellow.
|
||
|
||
|
||
|
||
| ✅ Success |
|
||
| :----: |
|
||
| Confirm that the status has changed from ‘waiting’ to ‘suspended’|
|
||
||
|
||
|
||
## Resume a Process
|
||
|
||
Resuming a process is essential for ensuring that the process can continue its execution, recover from interruptions, and proceed with the necessary updates or corrections.
|
||
|
||
> **Step 1: Locate Resume Icon**
|
||
|
||
|
||
|
||
- Next to the Process Instance Id, look for the icon that resembles the 'Resume' icon and select it to resume the suspended process instance.
|
||
|
||
> **Step 2: Select Resume Button**
|
||
|
||
- Click on the 'Resume' button.
|
||
This action will cause the process instance to go back to its active state, allowing the process instance to continue.
|
||
Depending on where the process instance is in its journey, the status might be waiting or some other active status.
|
||
The process instance remains highlighted in yellow.
|
||
|
||
|
||
|
||
| ✅ Success |
|
||
| :----: |
|
||
| Confirm that the status has changed from ‘suspended’ to an active status.|
|
||
|
|
||
|
||
## Terminate a Process Instance
|
||
|
||
Terminating refers to ending the execution of a specific occurrence of a process before it reaches its natural completion or final outcome.
|
||
There are various reasons for terminating a process instance such as the instance is no longer required or it's in an error state.
|
||
|
||
> **Step 1: Locate Terminate Icon**
|
||
|
||
|
||
|
||
- Next to the Process Instance Id, look for the icon that resembles the 'Terminate' icon and select it to terminate the process instance.
|
||
|
||
> **Step 2: Select Terminate Button**
|
||
|
||
- Click on the 'Terminate' button.
|
||
Note that the process instance will be terminated permanently, and this action cannot be undone.
|
||
|
||
> **Step 3: Confirm Termination**
|
||
|
||
- Before proceeding with the termination, it is essential to be absolutely certain about your decision.
|
||
|
||
|
||
- The process status will now be 'Terminated' and the last active task will be highlighted in purple.
|
||
|
||
|
||
| ✅ Success |
|
||
| :----: |
|
||
| Confirm that the status has changed from ‘suspended’ to 'terminated' |
|
||
 |
|
||
|
||
## Reset a Process
|
||
|
||
> **Step 1: Find the active Process Instance**
|
||
|
||
> **Step 2: Navigate to the active User Task**
|
||
|
||
👤 Note that you need Admin rights to complete the following steps.
|
||
|
||
> **Step 3: Suspend the Process**
|
||
|
||
Ensure the status has changed from *user_input_required* to *suspended*
|
||
|
||
|
||
> **Step 4: Go to the relevant past activity**
|
||
|
||
Only a previously completed section highlighted in grey can be chosen.
|
||
|
||
> **Step 5: Select 'View process instance at the time when this task was active.
|
||
'**
|
||
|
||
|
||
|
||
> **Step 6: Observe the task once highlighted in grey should now be yellow.
|
||
**
|
||
|
||
A previously completed section is now active and shown in yellow.
|
||
|
||
> **Step 7: Select 'Reset Process Here' icon in the popup window.
|
||
**
|
||
|
||
|
||
|
||
> **Step 8: "Resume" process instance.
|
||
** The process instance should be resumed by selecting the ‘Resume’ icon next to the Process Instance Id.
|
||
|
||
|
||
|
||
> **Step 9: Refresh page**
|
||
|
||
Wait for Resume action to complete, this may take some time.
|
||
Refresh the page to ensure it has transitioned to the next activity, replacing the current one.
|
||
|
||
<aside> ✅ From this point onward, the remaining part of the process can smoothly proceed.
|
||
</aside>
|