Skip to main content

Maintenance Windows

Maintenance Windows let you define scheduled periods when notifications and/or auto-restarts are suppressed. Use them during planned maintenance, deployments, or other activities when job failures are expected.


Overview​

Why Maintenance Windows?​

During planned maintenance, you may experience expected job failures:

  • System updates: BC upgrades or extension deployments

  • Database maintenance: Index rebuilds, data migrations

  • External service changes: API updates, certificate renewals

  • Infrastructure changes: Server moves, network changes

Maintenance windows prevent notification storms and unnecessary auto-restart attempts during these periods.

What Gets Suppressed​

You can suppress either or both:

OptionEffect
Suppress NotificationsNo alerts sent to channels
Suppress Auto-RestartNo automatic job restarts

Creating Maintenance Windows​

Step 1: Open Maintenance Windows​

  1. Search for Maintenance Windows

  2. Or from Job Queue Admin Setup: Actions > Navigate > Maintenance Windows

image-20260208-203732.png

Step 2: Create New Window​

  1. Click New to create a new maintenance window

  2. Fill in the required fields:

FieldValueExample
DescriptionDescriptive name"Weekly Sunday Maintenance"
EnabledYesYes
Start DateTimeWhen window begins2024-01-21 02:00
End DateTimeWhen window ends2024-01-21 06:00

Step 3: Configure Suppression​

Set what to suppress during the window:

FieldDescriptionRecommended
Suppress NotificationsStop all alertsYes
Suppress Auto-RestartStop automatic restartsDepends on scenario

Step 4: Configure Filters (Optional)​

Limit window to specific contexts:

FieldDescription
Category CodeOnly apply to specific job category
Company FilterOnly apply to specific companies

Window Types​

One-Time Windows​

For specific planned events:

ScenarioStart DateTimeEnd DateTime
BC Upgrade2024-01-20 18:002024-01-21 08:00
Data Migration2024-01-15 22:002024-01-16 02:00
API Maintenance2024-02-01 00:002024-02-01 04:00

Recurring Windows​

For regular maintenance schedules:

  1. Set Recurring to Yes

  2. Configure recurrence times:

FieldDescription
Recurrence Time StartDaily start time
Recurrence Time EndDaily end time
ScenarioDaysStart TimeEnd Time
Nightly batch windowAll02:0004:00
Weekend maintenanceSat-Sun00:0006:00
Daily backup windowAll23:0023:30

Window Fields Reference​

Identification​

FieldDescriptionRequired
Entry No.Auto-assigned unique IDAuto
DescriptionDescriptive nameYes
EnabledActive/inactive toggleYes

Timing (One-Time)​

FieldDescriptionRequired
Start DateTimeWindow startYes (if not recurring)
End DateTimeWindow endYes (if not recurring)

Timing (Recurring)​

FieldDescriptionRequired
RecurringEnable recurring modeNo
Recurrence Time StartDaily start timeIf recurring
Recurrence Time EndDaily end timeIf recurring

Suppression Options​

FieldDescriptionDefault
Suppress NotificationsStop notification deliveryYes
Suppress Auto-RestartStop automatic restartsYes

Filters​

FieldDescriptionDefault
Category CodeJob category filter(all)
Company FilterCompany name filter(all)

Filter Configuration​

Category Filtering​

Apply window to specific job categories:

  1. Set Category Code to target category

  2. Only jobs with matching category are affected

  3. Other categories continue normally

Example: Suppress notifications for "EDI" category during EDI server maintenance.

Company Filtering​

Apply window to specific companies:

  1. Set Company Filter to target company name

  2. Only jobs in that company are affected

  3. Other companies continue normally

Example: Suppress during CRONUS company data refresh while production continues.

Combined Filters​

Filters combine with AND logic:

Category CodeCompany FilterResult
EDICRONUSOnly EDI jobs in CRONUS
EDI(blank)All EDI jobs, any company
(blank)CRONUSAll jobs in CRONUS
(blank)(blank)All jobs, all companies

Checking Active Windows​

From List Page​

  1. Open Maintenance Windows

  2. Select a window

  3. Click Check If Active action

  4. System displays whether window is currently active

image-20260208-203857.png

Programmatically​

The system automatically checks maintenance windows when:

  • Processing job failure events

  • Before sending notifications

  • Before attempting auto-restart


Suppression Scenarios​

Full Suppression​

During major maintenance:

FieldValue
Suppress NotificationsYes
Suppress Auto-RestartYes

Result: Complete silence - no alerts, no restarts.

Notifications Only​

For expected transient failures:

FieldValue
Suppress NotificationsYes
Suppress Auto-RestartNo

Result: Auto-restart continues, but no alert noise.

Auto-Restart Only​

When manual control needed:

FieldValue
Suppress NotificationsNo
Suppress Auto-RestartYes

Result: Alerts sent, but no automatic recovery attempts.


Overlap Handling​

Multiple Active Windows​

When multiple windows are active:

  • All active windows are checked

  • If ANY window suppresses notifications → notifications suppressed

  • If ANY window suppresses auto-restart → auto-restart suppressed

Overlapping Times​

Windows can overlap:

WindowTimeSuppress NtfSuppress Restart
A02:00-04:00YesNo
B03:00-05:00NoYes

At 03:30: Both notifications AND auto-restart are suppressed.


Best Practices​

Window Planning​

  1. Create ahead of time: Set up windows before maintenance

  2. Include buffer: Add 30-60 minutes after maintenance

  3. Document purpose: Use clear description

Suppression Strategy​

ScenarioNotificationsAuto-Restart
Planned BC upgradeSuppressSuppress
Database reindexSuppressAllow
External API maintenanceSuppressSuppress
Network maintenanceSuppressAllow

Maintenance​

  1. Review regularly: Delete expired one-time windows

  2. Verify timing: Check time zones are correct

  3. Test before critical: Use Check If Active action


Common Scenarios​

Weekly BC Update Window​

Description: Weekly BC Update Window
Recurring: Yes
Recurrence Time Start: 02:00
Recurrence Time End: 04:00
Active Days: Saturday, Sunday
Suppress Notifications: Yes
Suppress Auto-Restart: Yes

Nightly Batch Window​

Description: Nightly Batch Processing
Recurring: Yes
Recurrence Time Start: 23:00
Recurrence Time End: 01:00
Active Days: All
Suppress Notifications: Yes
Suppress Auto-Restart: No

One-Time Migration​

Description: Customer Data Migration 2024-01-20
Recurring: No
Start DateTime: 2024-01-20 20:00
End DateTime: 2024-01-21 08:00
Suppress Notifications: Yes
Suppress Auto-Restart: Yes

Troubleshooting​

Window Not Suppressing​

SymptomCauseSolution
Still getting notificationsWindow not enabledSet Enabled = Yes
Wrong time activeTime zone issueVerify DateTime is correct
Only some jobs affectedFilter setCheck Category/Company filters

Unexpected Suppression​

SymptomCauseSolution
No notifications during business hoursRecurring window too broadNarrow recurrence times
Some jobs suppressedCategory filterReview filter settings

Checking What's Active​

  1. Open Maintenance Windows

  2. Set filter: Enabled = Yes

  3. Check each window with Check If Active action


Next Steps: Configure Digest Schedules to receive periodic summary reports, or review Notification Log for delivery history.