Metadata API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
SchedulingObjective
Parent Type
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 |
|
| masterLabel |
|
| schedulingCategory |
|
| schedulingObjectiveParameters |
|
| schedulingObjectiveType |
|
SchedulingObjectiveParameter
Represents a parameter that’s associated with a scheduling objective.
| Field Name | Description |
|---|---|
| parameterKey |
|
| value |
|
Declarative Metadata Sample Definition
The following is an example of a SchedulingObjective component.
1<?xml version="1.0" encoding="UTF-8"?>
2<SchedulingObjective xmlns="http://soap.sforce.com/2006/04/metadata">
3 <masterLabel>Balance Shifts</masterLabel>
4 <schedulingCategory>B</schedulingCategory>
5 <schedulingObjectiveType>BalanceShifts</schedulingObjectiveType>
6 <schedulingObjectiveParameters>
7 <parameterKey>DaysAhead</parameterKey>
8 <value>30</value>
9 </schedulingObjectiveParameters>
10</SchedulingObjective>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>SchedulingObjective</name>
5 <members>Balance Shifts</members>
6 </types>
7 <version>55.0</version>
8</Package>Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.