SchedulingObjective

Represents a scheduling objective in Workforce Engagement. Scheduling objectives define business goals that the scheduling tools consider when identifying agents for shifts.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

SchedulingObjective components have the suffix .SchedulingObjective and are stored in the SchedulingObjective folder.

Version

SchedulingObjective components are available in API version 55.0 and later.

Special Access Rules

This type is available only if Workforce Engagement is enabled in your org. To view, create, edit, and delete records, the user requires the Workforce Engagement Planner permission set.

Fields

Field Name	Description
isProtected	Field Type boolean Description Indicates whether the component is protected (`true`) or not (`false`). The default value is `false`.
masterLabel	Field Type string Description Required. The name of the objective.
schedulingCategory	Field Type SchedulingCategory (enumeration of type string) Description Required. What the scheduling logic applies the objective to. The valid values are: `A`—Service Appointment `B`—Shift
schedulingObjectiveParameters	Field Type SchedulingObjectiveParameter[] Description Parameters associated with a scheduling objective, such as the number of days before and after a shift that the logic considers when balancing assignments.
schedulingObjectiveType	Field Type SchedulingObjectiveType (enumeration of type string) Description Required. Specifies the type of objective. Possible values are: `AgentPreference`—In the UI, this value appears as Maximized Preferences. `BalanceNonStandardShifts` `BalanceShifts`