LanguageSettings

Represents an organization’s language settings. Language settings control end-user language selection, locale formats, and translation options.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

This type extends Metadata and inherits its fields.

LanguageSettings values are stored in the Language.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Introduced in API version 47.0.

• Type: string
• Required: No
• Introduced: API version 68.0
• Description: A comma-separated list of Salesforce language locale codes to display, such as en_US, fr, de, ja. The order of the codes determines the order in which languages appear in the list, matching the language order setting in the UI. Specify all to display all languages available to the org. If omitted, the existing configuration doesn’t change.

• Type: boolean
• Required: No
• Description: Indicates whether the ICU format is enabled for the en_CA locale (true) or not (false). This field has a default value of true for orgs created in API version 47.0 and later. Orgs created prior to API version 47.0 have a default of false.

• Type: boolean
• Required: No
• Introduced: API version 49.0
• Description: Indicates whether data translation is enabled (true) or not (false). This field has a default value of false.

• Type: boolean
• Required: No
• Description: Indicates whether end-user languages are enabled (true) or not (false). This field has a default value of false.

• Type: boolean

• Required: No

• Description: Indicates whether date and currency are formatted with the International Components for Unicode (true) or not (false). This field has a default value of true for orgs created in API version 47.0 and later. Orgs created prior to API version 47.0 have a default of false.

  See Go Global with New International Locale Formats for more information.

• Type: boolean
• Required: No
• Introduced: API version 58.0
• Version: Beta.
• Description: Indicates whether the org has enabled language extension packages (true) or not (false). Language extension packages contain translations of components in other packages. This field has a default value of false.

• Type: boolean
• Required: No
• Introduced: API version 56.0
• Description: Indicates whether users can filter query results, regardless of the locale or language associated with the user (true) or if they can’t filter results (false). This field has a default value of false.

• Type: boolean
• Required: No
• Introduced: API version 48.0
• Description: Indicates whether local name fields can be defined for standard objects (true) or not (false). This field has a default value of false.

• Type: boolean
• Required: No
• Description: Indicates whether platform-only languages are enabled (true) or not (false). This field has a default value of false. Setting this field to true also sets enableEndUserLanguages``true.

• Type: boolean
• Required: No
• Description: Indicates whether the Translation Workbench is enabled (true) or not (false). This field has a default value of false.

• Type: boolean
• Required: No
• Introduced: API version 67.0
• Description: Indicates whether the Translation Workbench Connect REST API is enabled (true) or not (false). This field has a default value of false.

• Type: boolean
• Required: No
• Description: Indicates whether translation follows the language fallback rule (true) or returns the primary label (false). This field has a default value of true.

The following is an example of a LanguageSettings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<LanguageSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <displayedLanguages>en_US,fr,de,ja</displayedLanguages>
4    <enableCanadaIcuFormat>true</enableCanadaIcuFormat>
5    <enableDataTranslation>false</enableDataTranslation>
6    <enableEndUserLanguages>true</enableEndUserLanguages>
7    <enableICULocaleDateFormat>true</enableICULocaleDateFormat>
8    <enableLocalNamesForStdObjects>false</enableLocalNamesForStdObjects>
9    <enablePlatformLanguages>false</enablePlatformLanguages>
10    <enableTranslationWorkbench>true</enableTranslationWorkbench>
11    <useLanguageFallback>true</useLanguageFallback>
12</LanguageSettings>

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        <members>Language</members>
5        <name>Settings</name>
6    </types>
7    <version>49.0</version>
8</Package>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.