Scheduler Scripts and Custom Rules

What Are Scheduler Scripts?

Scheduler scripts (also called the Rule Notebook) let you define custom scheduling rules in plain English. These rules act as constraints and preferences that the auto-scheduler follows when generating shift assignments.

For example, you can write rules like "No employee should work more than 5 consecutive days" or "Sarah Thompson should not be scheduled on Fridays."

Accessing the Rule Notebook

Navigate to Settings > Scheduler Scripts from the settings sidebar.

The Rule Notebook

The rule notebook has two tabs:

My Rules

A text editor where you write your scheduling rules in plain English. Rules are auto-saved as you type (with a brief delay).

Write one rule per line. Be clear and specific:

• "No employee should work more than 40 hours per week"
• "Always schedule at least 2 nurses at Sunrise Family Medicine"
• "Robert Chen should not work night shifts"
• "Ensure at least 1 senior staff member per shift"
• "Avoid scheduling Emily Nguyen and James Patel on the same day"

Template Library

A collection of pre-built rule templates covering common scheduling constraints. Browse the library and click to insert a template into your rules. You can then customize it for your specific needs.

Template categories include:

• Maximum hours and overtime limits
• Consecutive day restrictions
• Role coverage minimums
• Employee-specific preferences
• Shift spacing requirements

Creating Multiple Rule Sets

If you need different rules for different situations:

1. Click New Rule Set
2. Enter a name and optional description
3. Write your rules
4. Set which rule set is active

Only one rule set can be active at a time. The active rule set is used by the auto-scheduler and autopilot.

Testing Rules

Before relying on your rules for real schedules, test them:

1. Click Test to open the sandbox
2. The sandbox simulates scheduling with your rules applied
3. Review the results to verify your rules produce the expected outcome
4. Adjust rules as needed and test again

Testing does not affect your live schedules.

Version History

Every change to your rules is tracked with version history:

1. Click Version History to see past versions
2. Compare versions to see what changed
3. Restore a previous version if a recent change caused issues

Advanced Configuration

For power users, the rule notebook includes an advanced JSON configuration editor for fine-tuning optimizer weights and thresholds. This controls how strongly the scheduler prioritizes different constraints when conflicts arise.

Most users will not need to modify the advanced configuration.

How Rules Are Applied

When you create a draft schedule or run autopilot:

1. The auto-scheduler reads your active rule set
2. Rules are compiled into constraints for the scheduling algorithm
3. Hard constraints (must follow) are enforced strictly
4. Soft constraints (prefer) are followed when possible but may be relaxed if needed to fill coverage
5. The generated schedule respects all rules as closely as possible

Tips

• Start simple: Begin with a few essential rules and add more as you learn what works
• Be specific: "Max 5 consecutive days" is clearer than "Don't overwork people"
• Test after changes: Always test your rules before relying on them for real schedules
• Use the template library: It covers common scenarios and saves you from writing rules from scratch
• Keep rules manageable: Too many conflicting rules can make it impossible for the scheduler to find a valid solution