How do I create, edit, duplicate or delete a maintenance schedule?

Permissions required for maintenance schedules

To create a new maintenance schedule

To edit a maintenance schedule

To duplicate a maintenance schedule

To delete a maintenance schedule

To split a maintenance schedule

To sync schedules

RESTful API

Permissions required for maintenance schedules:

In order to view and edit maintenance schedules, users will need to be either Administrators or belong to a user group that has the Maintenance permission. Please see this article for help and information on setting permissions for user groups.

Users will also need the Inventory Administration permission in order to view and add devices to maintenance schedules.

To create a maintenance schedule:

There are two ways in which you can create a maintenance mode schedule:

• via the Maintenance Mode page.
• via the Context Menu of a device or devices.

Via the Maintenance Mode page:

1. Click Main Menu and then Administration. This will open the Administration page.
2. Click Maintenance Mode. This will open the Maintenance Mode page.
3. Click New Maintenance at the top of the page.
   
   
   
   
4. This will open the New Maintenance form.
   
   

Via the Context Menu of a device or devices:

1. Navigate to the device or devices for which you want to schedule maintenance. Right click on the device(s) to open the Context Menu.
2. On the Context Menu, click Put Into Maintenance.
   
   
   
   
3. This will open the New Maintenance form.
   
   

Once you have opened the New Maintenance form, follow these instructions:

1. Enter a name for the maintenance mode schedule in the Name field.
2. Enter a description for the schedule in the Description field.
3. Click the Selected Devices field to open the Devices form.
   
   
   
   Note, you need the Inventory Administration tool permission to access the Selected Devices field. Here, you can add devices to the schedule, via the + Add Devices field, which opens an explorer browser. Please note, if you have accessed the New Maintenance form via the Context Menu, the selected devices will be already populated.
   
   
   
   
   1. Search for devices and add them by clicking Done in the top right of the explorer. Note, in the explorer browser you can click and add a View, which will add all the devices within that View (but not the View itself).
   2. The devices that you have selected will appear in the list. To remove a device from the schedule, either click Delete all devices beneath or click the individual device and then Delete device.
   3. Once you have added the devices you want to, click Done in the top right of the Devices form to return to the New Maintenance form.
4. Specify if you want to suppress events during the maintenance mode via the Suppress Events switch. When switched to On, all events will be suppressed during the time period of the maintenance mode.
5. In the Interval field, specify if you want the schedule to run After or In Between a time and date, and then specify that time and date. E.g., specify if you want the schedule to only run between 1st November and 30th November.
   
   
   
   
6. Specify if you want the schedule to be Enabled or Disabled in the Schedule Maintenance field.
   
   
   
   
7. If Scheduled Maintenance is set to Enabled, you can then click on the Schedule field, which will open the Schedule form.
   1. On this form, specify the time of day, days of the week, and months in which the schedule will run.
   2. Once you have specified the schedule, click Done in the top right to return to the New Maintenance form, otherwise click Cancel.
8. Specify if you want to invert the specified schedule in the Invert Scheduled Rules field. When switched to On, the active parts of the schedule will become inactive, and the inactive parts will become active.
9. Click Done in the top right of the form to save your maintenance mode schedule, otherwise click Cancel.

To edit a maintenance schedule:

1. Navigate to the Maintenance Mode page.
2. Select the schedule that you want to edit.
3. Click Edit/View Maintenance via either the Overflow Menu or via the right click Context Menu.
   
   
   
   
4. This will open the Edit Maintenance form, which has the same fields as the New Maintenance form (see above). Note in the below screenshot, there is a warning about impacts upon past reports.
   
   
   
   
5. Make the changes as you need and then click Done to save your changes, otherwise click Cancel.

To duplicate a maintenance schedule:

You can duplicate any schedule, including schedules that are managed by an external server. The duplicated schedule will be owned by the server on which it has been duplicated, and you can modify it as you wish.

1. Navigate to the Maintenance Mode page.
2. Select the schedule that you want to duplicate.
3. Click Duplicate Maintenance via either the Overflow Menu or via the right click Context Menu.
   
   
   
   
4. This will open the New Maintenance form, which will have the same attributes as the schedule that is being duplicated.
   
   
   
   
5. Make the changes that you want to make and click Done to save, otherwise click Cancel.

To delete a maintenance schedule:

1. Navigate to the Maintenance Mode page.
2. Select the schedule that you want to delete.
3. Click Delete Maintenance via either the Overflow Menu or via the right click Context Menu.
   
   
   
   
4. A confirmation window will open, asking you to confirm the deletion. Click Yes or No.
   
   

To split a maintenance schedule:

You can split a maintenance schedule that has its start time before the current time, and its end time after the current time. Splitting a maintenance schedule therefore allows you to modify an existing schedule without affecting the past results that the schedule would have made. E.g., it is a 1pm on a Monday, and you have a maintenance schedule that started at 9am on the Monday and will end at 5pm on the Monday. This causes the following to happen:

• a copy of the schedule is created.
• the copy has its start time at 9am and end time at 1pm.
• the original schedule has its start time now changed to 1pm and the end time at 5pm.
• any edits you make to the original schedule after this split will apply only to the original, and nothe copy. You will have to separately edit the copy schedule.

To split a maintenance schedule:

1. Navigate to the Maintenance Mode page.
2. Select the schedule that you want to split.
   
   
   
   
3. Click Split Maintenance via either the Overflow Menu or via the right click Context Menu.
4. The copy will appear above the original in the table, with the appropriate start and end times updated for both the copy and the original.
   
   

To sync schedules:

Schedules are synced from the central Entuity server, pushed to any remote servers that have devices in those schedules. If the schedule does not already exist on the remote server, then that schedule will be created on the remote server, with the same settings as with the original schedule.

There are three occasions on which schedules are synced:

• all schedules are automatically synced daily.
• schedules are automatically whenever one is added, edited or deleted. This will only sync the relevant schedule, and will not affect other schedules.
• you can manually sync all schedules schedules by clicking Sync Now in the Overflow Menu on the Maintenance Mode page. This option only appears if you are managing another server.

RESTful API:

Please see the following for help and information on managing maintenance mode functionality via Entuity RESTful API:

• List available maintenance schedules or create a new maintenance schedule.
• List details of, modify, or delete a specified maintenance schedule.