WorkforceEngagementSettings | Metadata API Developer Guide

File Suffix and Directory Location

WorkforceEngagementSettings components are stored in the WorkforceEngagement.settings folder.

Version

enableMachineLearningForecasting and enableWorkforceEngagement are available in API version 52.0 and later. enableWorkforceEngagementConfiguration is available in 53.0 and later. enableHistoricalAdherence and enableIndividualAdherence are available in 54.0 and later. enableIntradayManagement and enableRealTimeAdherence are available in 55.0 and later.

Special Access Rules

To use Workforce Engagement settings, the org requires 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`).
enableWorkforceEngagementConfiguration	boolean	Indicates whether the Workforce Engagement Configuration App is installed or enabled (`true`) or not (`false`). If `true`, it grants access to the Lightning App as well as the app's Job Profile Mapping tab. It also defaults the standard and custom profile tab settings to On. If `false`, it removes access to the app and tab but doesn’t delete the app metadata.
enableHistoricalAdherence	boolean	Indicates whether historical adherence is enabled (`true`) or not enabled (`false`).
enableIndividualAdherence	boolean	Indicates whether individual adherence is enabled (`true`) or not enabled (`false`).
enableIntradayManagement	boolean	Indicates whether the intraday management dashboard is enabled (`true`) or not enabled (`false`).
enableRealTimeAdherence	boolean	Indicates whether real-time adherence is enabled (`true`) or not enabled (`false`). To use real-time adherence, you must also enable Omni-Channel.

Declarative Metadata Sample Definition

The following is an example of a WorkforceEngagement.settings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WorkforceEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <enableMachineLearningForecasting>true</enableMachineLearningForecasting>
4   <enableWorkforceEngagement>true</enableWorkforceEngagement>
5   <enableWorkforceEngagementConfiguration>true</enableWorkforceEngagementConfiguration>
6   <enableHistoricalAdherence>true</enableHistoricalAdherence>
7   <enableenableIndividualAdherence>true</enableIndividualAdherence>
8   <enableIntradayManagement>true</enableIntradayManagement>
9   <enableRealTimeAdherence>true</enableRealTimeAdherence>
10</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     <55.0>[ftest]</55.0>
88 </Package>

Usage

When enableMachineLearningForecasting is set to false, we 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.