Installed with SM Planned Maintenance
Summarize
Summarized using AI
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.
Summary of Installed with SM Planned Maintenance
The SM Planned Maintenance plugin provides a structured approach to managing maintenance plans and schedules within ServiceNow. It includes core functionality, demo data, and various components such as tables, roles, scripts, client scripts, business rules, and scheduled jobs to automate and streamline planned maintenance activities.
Show less
Key Features
- Tables: Define and relate maintenance plans, schedules, and records. For example:
- Maintenance Plan Record: Links schedules to system records and tracks last and next run times or values.
- Schedule Template: Connects maintenance schedules with service management templates.
- Maintenance Plan: Specifies which tables and records a maintenance plan applies to.
- Maintenance Schedule: Defines schedule types such as duration, meter, condition, or script-based schedules.
- Roles: Includes a dedicated administrator role (
planmaintadmin) to manage planned maintenance settings and configurations. - Script Includes: Provide utility functions and AJAX endpoints to support planned maintenance operations.
- Client Scripts: Dynamically update form fields on maintenance schedule and plan forms, ensuring proper validation and user interface behavior based on selected trigger types, repetitions, and models.
- Business Rules: Automate actions such as updating maintenance records upon service order closure, recalculating schedule run times, and managing active status changes across maintenance plans, schedules, and records.
- Scheduled Jobs: Includes a nightly job that builds maintenance requests from active maintenance plans, enabling automated maintenance execution.
Key Outcomes
- Enables customers to define comprehensive maintenance plans and schedules tailored to their operational needs.
- Automates tracking and execution of maintenance activities, including calculating next run times and reacting to changes in active status.
- Improves maintenance management efficiency by integrating with service orders and applying plans to new records automatically.
- Provides administrator-level controls and utilities to customize and manage planned maintenance effectively.
The SM Planned Maintenance core plugin also includes demo data.
Tables installed with SM Planned Maintenance
| Table | Description |
|---|---|
| Maintenance Plan Record [sm_m2m_maint_plan_to_record] |
Relates a maintenance schedule to a record in the system (from a document ID). Also contains information about the last time or value the schedule was run for the record and the next time or value when the schedule will run. |
| Schedule Template [sm_m2m_schedule_template] |
Relates a maintenance schedule to service management templates. |
| Maintenance Plan [sm_maint_plan] |
Defines a maintenance plan, including which table and records the plan applies to. |
| Maintenance Schedule [sm_schedule] |
Defines a schedule that is part of a maintenance plan. A schedule can be duration, meter, condition, or script based. |
Roles installed with SM Planned Maintenance
| Role title [name] | Description |
|---|---|
| plan_maint_admin | Administrator for planned maintenance. |
Script includes installed with SM Planned Maintenance
| Script include | Description |
|---|---|
| PlannedMaintenanceUtils | Utilities for planned maintenance. |
| PlannedMaintenanceAjax | AJAX entry points into PlannedMaintenanceUtils. |
Client scripts installed with SM Planned Maintenance
| Client script | Table | Description |
|---|---|---|
| Update field display - trigger type chg | Maintenance schedule [sm_schedule] |
Updates the fields displayed on the maintenance schedule form based on the trigger type selected. |
| Update field display - repetition chg | Maintenance schedule [sm_schedule] |
Updates the fields displayed on the maintenance schedule form based on the repetition selected. |
| Update table when type changes | Maintenance plan [sm_maint_plan] |
Updates the table field based on the selected models (for model-based plans). |
| Validate the every field | Maintenance schedule [sm_schedule] |
Verifies that the every field is a positive number; else it defaults to 1. |
| Update table when models change | Maintenance plan [sm_maint_plan] |
Updates the table field based on the selected models (for model-based plans). |
Business rules installed with SM Planned Maintenance
| Business rule | Table | Description |
|---|---|---|
| Update maintenance plan record | Service Order [sm_order] |
Updates the maintenance records [sm_m2m_maint_plan_to_record] once a service order is closed. |
| Update m2m schedule records | Maintenance schedule [sm_schedule] |
Recalculates the next value or next run time when meter or duration fields change. |
| Active changes | Maintenance Plan Record [sm_m2m_maint_plan_to_record] |
Handles changes to the active flag for a maintenance plan record. |
| Active insert | Maintenance Plan Record [sm_m2m_maint_plan_to_record] |
Handles changes to the active flag for a maintenance plan record. |
| Active changes | Maintenance schedule [sm_schedule] |
Handles changes to the active flag for a maintenance schedule. |
| Active changes | Maintenance plan [sm_maint_plan] |
Handles changes to the active flag for a maintenance plan. |
| Active Insert | Maintenance schedule [sm_schedule] |
Handles changes to the active flag for a maintenance schedule. |
| Apply plan to new records | Maintenance plan [sm_maint_plan] |
Updates the business rule for applying a plan to new records whenever the Apply to new records field changes. |
Scheduled jobs installed with SM Planned Maintenance
| Scheduled jobs | Description |
|---|---|
| Planned Maintenance Nightly Run | Builds maintenance requests based on active maintenance plans. |