Installed with SM Planned Maintenance

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read
  • 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 core plugin provides comprehensive functionality to define, schedule, and automate maintenance plans within ServiceNow. It comes with demo data to help you get started and includes various components such as tables, roles, scripts, client scripts, business rules, and scheduled jobs. This plugin supports maintenance plans that can be duration-based, meter-based, condition-based, or script-based, enabling flexible maintenance management aligned with your operational needs.

    Show full answer Show less

    Key Features

    • Tables:
      • Maintenance Plan Record: Links maintenance schedules to system records and tracks last and next run times or values.
      • Schedule Template: Connects maintenance schedules to service management templates.
      • Maintenance Plan: Defines maintenance plans including target tables and records.
      • Maintenance Schedule: Specifies individual schedules within a maintenance plan, supporting multiple trigger types.
    • Roles: The planmaintadmin role provides administrative privileges for managing planned maintenance.
    • Script Includes: Utilities and AJAX entry points facilitate planned maintenance operations and integrations.
    • Client Scripts: Dynamic form updates ensure fields on maintenance schedule and plan forms respond to user selections, such as trigger type and repetition, improving usability and data accuracy.
    • Business Rules: Automate updates to maintenance records when service orders close, recalculate schedule run times based on changes, and manage active status changes across plans, schedules, and records. They also handle applying plans to new records automatically when configured.
    • Scheduled Jobs: A nightly job builds maintenance requests based on all active maintenance plans, ensuring timely execution of maintenance tasks.

    What You Can Expect

    By implementing the SM Planned Maintenance plugin, you enable structured and automated maintenance processes tailored to your asset records. The system keeps track of when maintenance is due, recalculates schedules dynamically, and automatically generates maintenance requests, reducing manual effort and risk of missed maintenance. Administrative controls and user-friendly form behavior facilitate efficient setup and management of maintenance plans.

    This solution supports enterprise maintenance management needs by integrating seamlessly with ServiceNow's service management templates and workflows, improving maintenance visibility and control.

    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.