Skip to main content
Configuration for ModelBuilder. The optional Registry generic keeps ruleConfigs type-safe for custom rule registries. When omitted, the config defaults to the built-in CP-SAT registry.

Type Parameters

Registry

Registry extends CpsatRuleRegistry = BuiltInCpsatRuleRegistry

RuleConfigEntry

RuleConfigEntry extends AnyCpsatRuleConfigEntry = CpsatRuleConfigEntry<Registry>

Properties

coverage
CoverageRequirement[]
required
members
SchedulingMember[]
required
Team members available for scheduling.
ruleConfigs
ruleConfigs?: RuleConfigEntry[]
Named rule configurations that will be compiled using the provided rule registry.
ruleRegistry
ruleRegistry?: Registry
Rule registry to use when compiling ruleConfigs. Defaults to the built-in CP-SAT registry.
rules
rules?: RuleDescriptorCompilation[]
Pre-compiled rules; use this for custom rules that are not part of the registry.
schedulingPeriod
SchedulingPeriod
required
Defines when scheduling should occur as a date range with optional dayOfWeek and dates filters that compose to narrow which days are included.
shiftPatterns
ShiftPattern[]
required
Available shift patterns (time slots) that members can be assigned to.