Installed with SM Planned Maintenance

  • Release version: Xanadu
  • Updated August 1, 2024
  • 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 ServiceNow customers with structured capabilities to define, schedule, and automate maintenance plans across various records in their system. This plugin includes demo data and integrates with service management templates to streamline maintenance activities.

    Show full answer Show less

    Key Features

    • Data Tables: The plugin installs several key tables, including:
      • Maintenance Plan Record: Links maintenance schedules to system records and tracks last and next run times or values.
      • Schedule Template: Connects maintenance schedules with service management templates.
      • Maintenance Plan: Defines maintenance plans specifying applicable tables and records.
      • Maintenance Schedule: Configures schedules that can be based on duration, meter, condition, or scripts.
    • Roles: A dedicated administrator role (planmaintadmin) is provided for managing planned maintenance.
    • Script Includes and Client Scripts: Utilities and AJAX entry points support planned maintenance operations, while client scripts dynamically update form fields based on user inputs such as trigger types, repetition, and selected models.
    • Business Rules: Automated rules update related records and recalculate schedule timings when relevant fields change, handle activation status changes, and ensure maintenance plans are applied to new records as configured.
    • Scheduled Jobs: A nightly job automatically builds maintenance requests from active maintenance plans, ensuring timely execution without manual intervention.

    Key Outcomes

    By using the SM Planned Maintenance plugin, ServiceNow customers can:

    • Consistently define and manage maintenance plans linked to specific records and templates.
    • Automatically generate and track maintenance schedules based on various trigger criteria.
    • Ensure maintenance execution is aligned with business requirements through automated updates and scheduled jobs.
    • Leverage built-in roles and scripts to simplify administration and customization of maintenance processes.

    This plugin enhances operational efficiency by automating routine maintenance management within the ServiceNow platform, reducing manual effort and improving maintenance reliability.

    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.