SchedulingRule

Represents scheduling rule settings for Workforce Engagement.

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

Version 

Introduced in API version 52.0.

Supported SOAP API Calls 

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• This object 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 

Description 

• Type: textarea
• Required: No
• Properties: Nillable

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

  When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

  Note

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 52.0

• Description: The full name of the associated metadata type in Metadata API. The full name can include a namespace prefix.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the scheduling rule.

Possible values are the supported languages in Workforce Engagement.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: Label for the scheduling rule. In the UI, this field is Scheduling Rule.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 52.0

• Description: The scheduling rule’s metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

SchedulingCategory 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Required. What the scheduling logic applies the rule to.

• Possible values:

  • A — Appointment — Service Appointment

  • B — Shift

  • C — Shift Activity

SchedulingRuleType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Specifies the type of rule.

• Possible values:

  • M — Match Territory

  • B — Match Skills

  • W — Work Limit

  • A — Active Resources

  • RestTimeMinutes — Minimum Rest Time Between Shifts In Minutes — Specifies a rule type that finds resources who have met the minimum rest time in minutes between consecutive shifts. Available in API version 56.0 and later.

  • Q — Match Queues

  • C — Availability

  • LimitNonstandardShifts — Limit Non-Standard Shifts — Specifies a rule type that limits how many non-standard shifts can be assigned to each agent. Available in API version 54.0 and later.

  • CountRule — Count Rule

  • ExcludedResources — Excluded Resources

  • ExtendedMatch — Extended Match

  • MatchBoolean — Match Boolean

  • MatchFields — Match Fields

  • MatchTimeRule — Match Time Rule

  • MaximumTravelFromHome — Maximum Travel From Home

  • RequiredResources — Required Resources

  • ServiceAppointmentVisitingHours — Service Appointment Visiting Hours

  • MatchCrewSize — Service Crew Resources Availability

  • TimeSlotDesignatedWork — Time Slot Designated Work

  • WorkingTerritories — Working Territories

  • AppointmentStartTimeInterval — Appointment Start Time Interval

  • MaxContractedWork — Maximum Hours (Pilot)

  • MultiBreaks — Multi Breaks

  • MinimumConsecutiveWeeklyRest — Minimum Consecutive Weekly Rest