---
schema_version: "1"
id: 6b4521d2294a7990048cf3b9315362c0b6ebae45cb3bac301f5c5046f1b9cbbd
title: EmployeeUserSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_employeeusersettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_employeeusersettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5ed37857a2f1db1e40082196ad3f75883afc929dad9debe2d998665dfc94b951
description: Represents the employee-user settings used for automatically creating or syncing employee and user data in work.com orgs. This type extends the Metadata metadata type and inherits its fullName field.
---
# EmployeeUserSettings

Represents the employee-user settings used for automatically creating or syncing employee and user data in work.com orgs. This type extends the Metadata metadata type and inherits its fullName field.

## File Suffix and Directory Location

A EmployeeUserSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

EmployeeUserSettings components are available in API version 50.0 and later.

## Special Access Rules

Access to the EmployeeUserSettings type requires the Workplace Command Center permission set license available in the org and assigned to the user. The WorkplaceCommandCenterUser scratch org feature must also be enabled in the org.

## Fields

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



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

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

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

            </tr>

          </thead>

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

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Required. <span class="ph" id="encodingKey_content_1"><a name="encodingKey_content_1"><!-- --></a>The default encoding setting is
                  Unicode: <samp class="codeph xml">UTF-8</samp>.</span>
                <div class="p">Valid values include:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph nolang">UTF-8</samp>—Unicode (UTF-8)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ISO-8859-1</samp>—General US &amp; Western
                      Europe (ISO-8859–1, ISO-LATIN-1)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Shift_JIS</samp>—Japanese (Shift-JIS)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ISO-2022-JP</samp>—Japanese (JIS)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">EUC-JP</samp>—Japanese (EUC-JP)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">x-SJIS_0213</samp>—Japanese
                      (Shift-JIS_2004)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">ks_c_5601-1987</samp>—Korean
                      (ks_c_5601-1987)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Big5</samp>—Traditional Chinese (Big5)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">GB2312</samp>—Simplified Chinese (GB2312)
                    </li>

                    <li class="li">
                      <samp class="codeph nolang">Big5-HKSCS</samp>—Traditional Chinese Hong
                      Kong (Big5–HKSCS)
                    </li>

                  </ul>
                </div>
              </td>

            </tr>

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

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

              <td class="entry" headers="d427003e103" data-title="Description">If <samp class="codeph nolang">true</samp>, users are auto-created when a new
                employee record is created. The default value for this field is <samp class="codeph nolang">false</samp>.</td>

            </tr>

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

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

              <td class="entry" headers="d427003e103" data-title="Description">If <samp class="codeph nolang">true</samp>, the employee record is the source
                of truth. The default value for this field is <samp class="codeph nolang">false</samp>.</td>

            </tr>

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

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Represents a set of permissions that's used to grant more access to a user. You
                can use permission sets to grant access but not to deny access.</td>

            </tr>

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

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Required. Represents a user profile. A profile defines a user’s permission to
                perform different functions within Salesforce.</td>

            </tr>

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

              <td class="entry" headers="d427003e100" data-title="Field Type">string</td>

              <td class="entry" headers="d427003e103" data-title="Description">Represents a domain name. We create a unique login by combining this domain
                name with each employee’s username.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example EmployeeUser.settings-meta.xml that deploys the EmployeeUserSettings metadata to an org. The file is in the dir path force-app/main/default/settings:

<?xml version="1.0" encoding="UTF-8"?>
<EmployeeUserSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<emailEncoding\>ISO-8859-1</emailEncoding\>
<enableEmployeeAutoCreateUser\>true</enableEmployeeAutoCreateUser\>
<enableEmployeeIsSourceOfTruth\>false</enableEmployeeIsSourceOfTruth\>
<profile\>MarketingProfile</profile\>
<usernameSuffix\>example.com</usernameSuffix\>
</EmployeeUserSettings\>

The following example of package.xml file retrieves the EmployeeUserSettings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<name\>Settings</name\>
<members\>EmployeeUser</members\>
</types\>
<version\>50.0</version\>
</Package\>