Define Rules with Rule Parameters
Explanation
Parameters for the rules are defined via the Rule_Parameter table. The following parameters can
be Specified depending on the rule type:
- ReferencePeriod: An optional parameter that applies to any of the shift capacity rule types.
It defines the length of the reference period to use for the rule.
- MaximumCount: A mandatory parameter for activity count rules. Defines the maximum number of
activities permitted within the given number of shifts or the reference period.
- MaximumTotalDuration: A mandatory parameter for activity duration rules. Defines the maximum
total activity duration permitted within the given number of shifts or the reference period.
- IncludeTravel: An optional parameter for activity duration rules. Specifies whether or not
travel durations should be included in the total duration. The default is false.
- MaximumTotalValue: A mandatory parameter for activity value rules or custom metric rules.
Defines the maximum total activity value or custom metric value permitted within the shift/reference
period.
- MetricId: A mandatory parameter for custom metric rules. Defines the id of the custom metric
to use for this rule.
- NumberOfShifts: An optional parameter that applies to any of the shift capacity rule types.
Defines the total number of consecutive shifts against which the rule applies. (Integer)
Prerequisites
Rules need to be defined beforehand.
System Effects
As a result of this activity, Rule Parameters can be added to a rule to better define a rule.