Skip to main content

Maintenance Plan Creation Guide

Nina BENDERAC
Updated

Available for

  • Roles: Administrator
  • Plans: Starter, Premium, On demand

Maintenance Plan Creation Guide

A maintenance plan can be created from the maintenance plans search page or directly from the equipment for which you wish to create the plan.

Creating a maintenance plan involves three steps:

  • Filling out general information,
  • Scheduling, and
  • Validation.

General Information

These details must be filled in before moving to the scheduling step.

  • Equipment (required): Choose the equipment or spare part for which the maintenance plan is being created.
  • Description (required): Define the description of the interventions that will be performed. Please click here to see how to format the description using markdown.
  • Specify if the maintenance plan is regulatory.
  • Assignees (required): This allows you to assign people or teams to a maintenance plan.
  • Observers (optional): Users who need to be notified upon completion of each task in this maintenance plan.
  • Labels (optional): Simplify task classification. Labels can be pre-defined to describe work orders, indicating information such as urgency levels, possibility of intervention without machine stoppage, etc. To learn more about using labels, click here.
  • Planned Maintenance Time (optional): The scheduled duration for preventive or corrective maintenance tasks, minimizing production downtime.
  • Planned Stopped Time (optional): Refers to periods during which equipment is intentionally stopped for maintenance, inspections, or repairs.
  • Spare Parts to Provide (optional): Helps plan the intervention effectively by anticipating required parts.
  • Checklist (optional): Represents check points or procedures to follow during the intervention.

Planning

Trigger

In this phase, it’s essential to choose the trigger type that matches your needs. To check which type to choose, please visit here.

Three options are available:

  • Fixed Date Trigger

Tasks repeat on specific dates.

  • Task Completion Trigger

The next task is generated once the current task is closed. It will be scheduled based on the last recorded activity (if any), considering the defined period.

  • External Trigger (via API)

The next task is triggered via the API.

Frequency

The frequency options change depending on the trigger type chosen above.

If you have selected the fixed date or task closure trigger, you can choose the frequency in X days, weeks, months, or years.

However, only the fixed date trigger allows you to select specific days of the week for the weekly frequency or a specific day of the month for the monthly frequency. For the monthly frequency, you can choose based on the date of the month or based on a specific day of the month (e.g., every three months, the 2nd Monday of the month).

If you opt for the API trigger, the frequency is not defined here. The plan is instead triggered dynamically via the API as per requirements.

Estimated Duration of Each Task

The estimated duration of tasks can be set in days, hours, or minutes.

Start Date of the Maintenance Plan

Finally, you need to choose the date from which the schedule begins.

The application defaults to the current date and time, but you can choose a different date and time in the future.

Throughout the scheduling process, you can rely on the calendar which shows upcoming tasks for your maintenance plan, along with the defined rule, dynamically updated with each change in parameters.

For illustration, if we chose a fixed trigger with a weekly frequency on Monday and Wednesday, and the plan starts on Tuesday, 11/5/2024, the task sequence will be as follows:

This schedule is not available for the API-triggered plan, as the task triggering (creation) depends entirely on the API call.

Validation

Once all parameters are chosen, you can proceed to the validation step. This consists of checking that the schedule and information are correctly filled in, and that the plan can be created.

If everything is correct, simply click the button to create the plan at the bottom of the page. A confirmation message will appear.

This message will be slightly different for the API trigger.

Creating a Maintenance Plan via API

Creating a maintenance plan via the API follows the same process as for fixed date or task closure plans. You use the regular interface to create your maintenance plan, but instead of specifying a date or closure event to trigger the task, you simply send the maintenance plan ID via the API. The ID is at the end of the URL of the plan page in question.

 

To create a task with a specific maintenance plan via the API, you simply make a POST call.

Here is an example using CURL:

jsx
Copy code
curl --request POST \\
  --url <https://app.mobility-work.com/partners/maintenance-plans/trigger/>{maintenance plan Id} \\
  --header 'Api-Key: {API Key}' \\
  --header 'Content-Type: application/json' \\
  --data '{}'

If the payload is valid and your API Key and Maintenance Plan ID are correct, the response will be an HTTP 200 code.

Each API call creates a maintenance task. Therefore, you can create multiple tasks per day if needed.

For more information, please refer to our API documentation here.

The network administrator can request the API key by emailing support at help@mobility-work.com or via the Help button in the app.

Related articles