---
schema_version: "1"
id: 2f4682378ab609977780729a57d88df79f1f9adcfc9a84fa201e320121e0e801
title: WorkforceEngagementSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_workforceengagementsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_workforceengagementsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 07a33bab5abb1098e59d491fc844c5880522da358ea51248a0bd356fead52bcf
description: Represents settings for Workforce Engagement Management.
---
# WorkforceEngagementSettings

Represents settings for Workforce Engagement Management.

## File Suffix and Directory Location

WorkforceEngagementSettings components are stored in the WorkforceEngagement.settings folder.

## Version

WorkforceEngagementSettings is available in API version 52.0 and later.

## Special Access Rules

To use Workforce Engagement settings, the org requires a Workforce Engagement license.

## Fields

Field Type

<table class="featureTable sort_table" summary="">



            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader  " id="d1039296e86">Field Name</th>

                <th class="featureTableHeader  " id="d1039296e89">Field Type</th>

                <th class="featureTableHeader  " id="d1039296e92">Description</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableMachineLearningForecasting</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether machine learning-based forecasting is used (<samp class="codeph nolang">true</samp>) or not used (<samp class="codeph nolang">false</samp>).</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableWorkforceEngagement</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether Workforce Engagement is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>).</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableWorkforceEngagementConfiguration</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">
                  <p class="p">Indicates whether the Workforce Engagement Configuration App is installed or
                    enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If <samp class="codeph nolang">true</samp>, 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 <samp class="codeph nolang">false</samp>, it removes access to the app
                    and tab but doesn’t delete the app metadata. This field is available in API
                    version 53.0 and later.</p>

                </td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableHistoricalAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether historical adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This
                  field is available in API version 54.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableIndividualAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether individual adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This
                  field is available in API version 54.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableIntradayManagement</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether the intraday management dashboard is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). This field is available in API version 55.0 and later.</td>

              </tr>

              <tr>
                <td class="entry" headers="d1039296e86" data-title="Field Name"><span class="keyword parmname">enableRealTimeAdherence</span></td>

                <td class="entry" headers="d1039296e89" data-title="Field Type">boolean</td>

                <td class="entry" headers="d1039296e92" data-title="Description">Indicates whether real-time adherence is enabled (<samp class="codeph nolang">true</samp>) or not enabled (<samp class="codeph nolang">false</samp>). To
                  use real-time adherence, you must also enable Omni-Channel. This field is available
                  in API version 55.0 and later.</td>

              </tr>

            </tbody>

          </table>

## Declarative Metadata Sample Definition

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

<?xml version="1.0" encoding="UTF-8"?>
<WorkforceEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
   <enableMachineLearningForecasting\>true</enableMachineLearningForecasting\>
   <enableWorkforceEngagement\>true</enableWorkforceEngagement\>
   <enableWorkforceEngagementConfiguration\>true</enableWorkforceEngagementConfiguration\>
   <enableHistoricalAdherence\>true</enableHistoricalAdherence\>
   <enableenableIndividualAdherence\>true</enableIndividualAdherence\>
   <enableIntradayManagement\>true</enableIntradayManagement\>
   <enableRealTimeAdherence\>true</enableRealTimeAdherence\>
</WorkforceEngagementSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
2 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <types\>
4         <members\>WorkforceEngagement</members\>
5         <name\>Settings</name\>
6     </types\>
7     <55.0>\[ftest\]</55.0>
8 </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.