Available for
- Roles: Administrator
- Plans: Starter, Premium, On demand
Pausing a maintenance plan may be necessary under various circumstances, generally to handle unforeseen events, optimize resources, or adjust priorities. This feature helps avoid unnecessary or redundant tasks.
Depending on the type of maintenance plan, the pausing process may vary.
The button to pause a plan is located at the top right of the maintenance plan page.
It is also possible to pause a plan from the plans search page, via the same button.
Note: A paused plan will no longer appear in the plans search. To find it, you must apply the corresponding filter in the Maintenance Plan Status field under Filters.
Pausing
Pausing a fixed-date maintenance plan
A fixed-date maintenance plan that is ongoing can be paused.
This action will remove all future, incomplete tasks. If any overdue active tasks exist, they will not be deleted.
If future tasks have already been canceled, they will be retained.
Pausing a task-completion maintenance plan
For a task-completion maintenance plan, it is important to consider the last active task, if one exists, or the last completed task to understand how the functionality works (especially when resuming the plan from pause).
If there is an active task and it is overdue (scheduled in the past or for the current day), it will not be deleted when pausing the plan. Therefore, it will not be affected by the change.
If there is an active task and it is scheduled for the future, this task will be deleted when the plan is paused.
Pausing a maintenance plan triggered by API
Pausing this type of plan is currently only possible through the interface.
The applicable rules are the same as for the other two types of plans: overdue active tasks are not affected by the pause, while future tasks, if any, are deleted.
If this maintenance plan (PDM) is called by the API while it is paused, an error (HTTP 409) will be returned in the response.
Resuming Maintenance Plans
To resume a maintenance plan from pause, click on the arrow button that appears on the plans search page or on the plan page itself.
Resuming a fixed-date maintenance plan
Once the fixed-date maintenance plan is resumed, occurrences will be generated again according to the rules defined in the plan.
The date from which the period for upcoming tasks is calculated will correspond to the resume date after the pause.
For example, if a fixed-date maintenance plan is scheduled every Monday, and the plan is paused on Monday, 11/11, a task will already have been generated for that date because it is a Monday. Whether this task is completed or not, if we resume the plan on Wednesday, 20/11, the next task will be scheduled for the following Monday, i.e., 25/11.
In another scenario, if the maintenance plan is paused on Friday, 8/11, the task scheduled for 11/11 will be deleted as it is in the future.
When resuming the plan on the same day (i.e., 8/11), a new task will be created for 11/11 (the next Monday), as if the plan had never been paused.
Resuming a task-completion maintenance plan
As mentioned earlier, for task-completion plans, the behavior depends on the date from which the next task date will be calculated.
The rule is as follows: the date of the next task will be determined based on the following:
- If an overdue or scheduled active task existed at the time of pausing: the next task will be scheduled on the date of the active task, with the duration of the pause period added.
- If no active task existed at the time of pausing, but a task had been completed previously: the date of the next task will be based on the last completed task, with the duration of the pause period added.
- If no task was completed before pausing: the date of the next task will be based on the plan's start date, with the pause duration added.
To illustrate, here are three examples of applying the rule for a task-completion maintenance plan, scheduled three days after each task is completed. Suppose the plan is paused on 12/11 and resumed on 17/11:
- An overdue task was scheduled for 9/11 but was not completed: the next task will be calculated from the overdue task date, adding the 5 days of the pause period. Thus, the next task will be scheduled for 14/11 (9/11 + 5 days of pause = 14/11).
- The last completed task was done on 10/11, but there was no active task at the time of pausing: in this case, the next task will be calculated from the last completed task date, adding the duration of the pause period. The next task will be scheduled for 15/11 (10/11 + 5 days of pause = 15/11).
- No task had been completed before the pause, and the start date of the maintenance plan is 11/11: the next task will be calculated from the start date of the plan, adding the 5 days of pause. The next task will be scheduled for 16/11 (11/11 + 5 days of pause = 16/11).
Resuming a maintenance plan triggered by API
When resuming this plan that has been paused, which occurs exclusively through the interface, the behavior differs from that of fixed-date or task-completion plans. Specifically, active tasks are not affected, and no new tasks are created when resuming the plan from pause.
For a new task to be generated, the API-triggered plan must be called through the API.