Scheduled Maintenance Mode for Perfex CRM Documentation ☰

Introduction

This documentation provides complete guidance on the installation, configuration, and usage of the Scheduled Maintenance Mode for Perfex CRM. This module enables administrators to schedule planned maintenance and automatically restrict system access during those periods.


Designed as a simple yet powerful plug-and-play add-on, the module offers automated start and end times, staff-based access control, and a clean maintenance screen with live countdown—ensuring uninterrupted workflows for internal teams while preventing client access during downtime. With built-in history logging and timezone-accurate scheduling, the module provides a professional and reliable way to handle system maintenance.

System Requirements

  • Perfex CRM v3.1.0 or higher

Installation

Installing the module is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the maintenance_mode.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the maintenance_mode.zip
  • Click Install to complete the process.
Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

Module Activation

Usage

Once the module is installed and activated, follow the steps below to schedule and manage maintenance effectively:

  • Accessing the Maintenance Mode Panel
    • Navigate to Utilities → Maintenance Mode from the admin sidebar.
    • This page displays a table listing all your maintenance schedules—upcoming, active, and completed.
  • Default Configuration Fields
    • You can configure and save default values such as Title, Message, Countdown Text, Contact Details, and Custom CSS.
    • These settings automatically prefill the form when creating a new schedule, allowing faster and more consistent setup.
  • Maintenance Schedule Actions
    • Edit: Available only if the schedule has not yet started.
    • Stop: Available only when the maintenance schedule is currently active.
    • Delete: Available at any time for any schedule (upcoming, active, or completed).
  • Creating a Maintenance Schedule
    • Title: Main heading displayed on the maintenance page.
    • Message: The maintenance message or description. Supports dynamic tags like:
      • {start_time} – Automatically replaced with formatted schedule start time.
      • {end_time} – Automatically replaced with formatted schedule end time.
    • Countdown Text: Text displayed above the countdown timer, with dynamic tag:
      • {countdown_time} – Replaced with the live countdown value.
    • Contact Details: Optional text to display contact information for urgent support.
    • Custom CSS: Add your own CSS to personalize the maintenance page design.
    • Allow All Staff: When enabled, all staff members can bypass maintenance mode.
    • Allowed Staff: Select specific staff to bypass maintenance while others remain restricted.
    • Start Time: When maintenance begins. You can schedule it for the future or set it to start immediately.
    • End Time: When maintenance automatically ends and system access is restored.

Support

For support, please reach out to us at codeonstring@gmail.com. We will respond as soon as possible, typically within one working day.

Changelog

VERSION 1.0.0 – Initial Release