diff --git a/docs/admin_guide/admin_guide.md b/docs/admin_guide/admin_guide.md new file mode 100644 index 000000000..2b426a8d8 --- /dev/null +++ b/docs/admin_guide/admin_guide.md @@ -0,0 +1,17 @@ +# Admin guide + +## Process Instance Operations + +### Deleting + +In order to delete a process instance, it must be in a terminal status, one of error, completed, or terminated. +Once it is in one of these statuses, go to the process instance show page and click the trash can icon next to the process instance id. + + +### Terminating + +Terminate a process instance if you want it to stop running and no future actions are needed. +If you want to perform other administrative actions on the instance, you may want to suspend it instead. + +In order to terminate a process instance, it must be in a running status, anything not a terminal status. +Once it is in one of these statuses, go to the process instance show page and click the stop icon next to the process instance id. diff --git a/docs/index.md b/docs/index.md index 8d55ad176..9f17d2e72 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,7 @@ quick_start/quick_start.md documentation/documentation.md how_to/bpmn_unit_tests.md +admin_guide/admin_guide.md wish_list/wish_list.md ```