Rostering rule checks and violations

Lumary WFM - This article provides an explanation of the checks available in rostering rules and what could cause violations.

Rostering rules can be combined in rostering engines to validate roster periods before they're published to the live Scheduling roster. Running a validation will return a list of violations and highlight some of the areas in the roster period that have caused them.

Required and supported packages

Available with: Lumary WFM

Supported in: Lumary DC

The following table provides a list of the rules, what they check and what could cause a violation. Names may be different in your environment.

Name and Apex class	Checks and violations
Check Availability BaseWorkerRules.CheckAvailability	Checks that there are no workers rostered for a session when they are unavailable. A violation occurs if: the worker is unavailable based on availability records (i.e. any availability records of unavailable availability type and status of approved against the worker’s contact record), or the worker is unavailable based on contact availability templates within the roster period (i.e. if the session falls on day/time that is outside of the worker’s contact availability template).
Check Worker Appointment Conflicts BaseWorkerAppointmentRules. DetectWorkerAppointmentConflicts	Checks that there are no workers rostered on overlapping sessions. A violation occurs if: the worker is rostered onto multiple worker appointment records for the same day/time.
Check Client Appointment Conflicts BaseClientRules.ValidateClients	Checks that there are no clients rostered on overlapping sessions. A violation occurs if: the client is rostered onto multiple client appointment records for the same day/time.
Check Contracted Hours BaseWorkerRules.CheckContractedHours	Checks if workers are exceeding or not meeting their contracted hours for the period. A violation occurs if: hours rostered goes over 100% of assignment - the violation will show as exceeded, or hours rostered is below 50% of assignment - the violation will show as not met.
Check Association Status BaseWorkerRules.CheckAssociationStatus	Checks that all workers on sessions within the roster period are associated by a contact availability template. A violation occurs if: the worker does not have at least one active contact availability template within the roster period.
Check Blocklist BaseWorkerRules.CheckBlocklist	Checks for any blocklist clashes on sessions within the roster period. A violation occurs if: there is a blocklist record that links both the client and worker assigned to the session.
Find Unassigned Appointments BaseWorkerAppointmentRules. FindUnassignedAppointments	Finds sessions and appointments that do not have workers assigned yet. A violation occurs if: there are any sessions within the roster period where one or more worker appointment records have no worker assigned to them.
Check Worker Status BaseWorkerRules.CheckWorkerStatuses	Checks that workers are in a status of active. A violation occurs if: the worker's contact record is not in a status of Active.
Check Client Status BaseClientRules.ValidateClients	Checks that clients are in a status of current. A violation occurs if: the client’s contact record is not in a status of Current.
Check Service Agreement Overclaim ServiceAgreementRules.SAOverclaimCheck	Checks that the clients' service agreements will not be overclaimed. A violation occurs if: the client's service agreement, category or item will exceed their total.
Check Service Agreement Status ServiceAgreementRules. SAStatusAndExpiryCheck	Checks that the clients' service agreements are in a status of current or are within the start and end dates. A violation occurs if: the client's Service Agreement is in a status of Current, or the session is within the start date and end date.
Check Service Time of Day and Day of Week IntelligentDynamicRates. DetectServiceRateConflicts	Checks that the planned service is rostered at the correct time of day and day of week. A violation occurs if: the client's planned service is not valid for the time of day and day of week the session is rostered for, based on the service's service definition records.