OmniChannelSettings

Represents the Omni-Channel settings for an org. This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

OmniChannelSettings values are stored in the OmniChannel.settings file in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

OmniChannelSettings components are available in API version 44.0 and later.

Fields

Field Name	Field Type	Description
enableOmniAutoLoginPrompt	boolean	Indicates whether to display a login confirmation upon loading a console with Omni-Channel. The default value is `false`. When `true`, the console displays a prompt before logging into Omni-Channel when an agent opens another Omni-Channel console in a different tab or window or refreshes the current tab. The agent is logged out of Omni-Channel on other consoles and any ongoing conversations are ended. Available in API version 47.0 and later.
enableOmniChannel	boolean	Indicates whether Omni-Channel is enabled, giving you access to the objects required to set up the feature in your org. The default value is `false`.
enableOmniSecondaryRoutingPriority	boolean	Indicates whether Secondary Routing Priority is enabled in your org. The default value is `false`. Available in API version 47.0 and later.
enableOmniSkillsRouting	boolean	Indicates whether skills-based routing is enabled in your org. The default value is `false`.

Declarative Metadata Sample Definition

The following is an example of a OmniChannelSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniChannelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableOmniChannel>true</enableOmniChannel>
4    <enableOmniAutoLoginPrompt>true</enableOmniAutoLoginPrompt>
5    <enableOmniSecondaryRoutingPriority>true</enableOmniSecondaryRoutingPriority>
6    <enableOmniSkillsRouting>true</enableOmniSkillsRouting>
7</OmniChannelSettings>

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

Wildcard Support in the Manifest File

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.

Metadata API Developer Guide