-
Notifications
You must be signed in to change notification settings - Fork 3
Home
The Scheduled Maintenance Component is a Salesforce Lightning Web Component (LWC) designed to notify users of upcoming system maintenance and restrict access to specific parts of Salesforce during maintenance windows—without blocking login or freezing all activity.
In organizations where different Salesforce apps or areas operate independently, it’s not feasible to freeze all user activity during deployments or maintenance, especially for long-running or major releases. Communication about these events is also challenging—while tools like Email and Slack help, nothing is as effective as an in-app popup message.
The component provides three main functions:
- Notify users of upcoming releases or system state changes.
- Inform users when a release or system state change is in progress.
- Restrict access to the system or specific apps during a release or state change.
- The component’s behavior is driven by records in the Scheduled Maintenance custom object.
- Maintenance records can be created or updated by anyone with access, including automation based on DevOps data or manual entry by non-admins.
- The Applicable Apps multi-select picklist on each record determines which apps or areas are affected.
- The component must be placed on the relevant Lightning pages or Experience Cloud sites to enforce restrictions or display alerts.
- Dynamic Updates: Maintenance information is refreshed at specified intervals, so users always see the latest status without needing to reload the page.
- Targeted Blocking: Admins can restrict access to specific apps or the entire system by configuring the component and maintenance records.
- Context Awareness: The app context can be set on the component, and maintenance targeting is controlled via the Applicable Apps field.
- User Experience: Users receive timely, clear alerts about maintenance activities and potential disruptions, improving transparency and reducing confusion.
Note:
The term "block" refers to making the popup modal non-dismissible during maintenance, effectively preventing actions on the page where the component is active. This does not block access to standard Salesforce pages like list views. The component only restricts actions on customizable Lightning record pages and Experience Cloud pages where it is placed. It does not provide a complete system-wide block.