Metadata API Developer Guide
jNewer Version Available
WorkforceEngagementSettings
Represents the Workforce Engagement
product. Specifically, the ability to enable Workforce Engagement and opt to use Machine
Learning-based forecasting.
File Suffix and Directory Location
WorkforceEngagementSettings components are stored in the WorkforceEngagement.settings folder.
Version
WorkforceEngagementSettings components are available in API version 52.0 and later.
Special Access Rules
To use enableWorkforceEngagement or enableMachineLearningForecasting, the org must have a Workforce Engagement license.
Fields
Field Type
| Field Name | Field Type | Description |
|---|---|---|
| enableMachineLearningForecasting | boolean | Indicates whether machine learning-based forecasting is used (true) or not used (false). |
| enableWorkforceEngagement | boolean | Indicates whether Workforce Engagement is enabled (true) or not enabled (false). |
Declarative Metadata Sample Definition
The following is an example of a WorkforceEngagement.settings component.
1<?xml version="1.0" encoding="UTF-8"?>
22 <WorkforceEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
33 <enableMachineLearningForecasting>true</enableMachineLearningForecasting>
44 <enableWorkforceEngagement>true</enableWorkforceEngagement>
55 </WorkforceEngagementSettings>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
22 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
33 <types>
44 <members>WorkforceEngagement</members>
55 <name>Settings</name>
66 </types>
77 <version>[ftest]</version>
88 </Package>Usage
When enableMachineLearningForecasting is set to False, we'll clean up data from our Ofek forecasting platform. The original copy of the same set of data is stored in the Core app, so no data is lost.