OmniChannelSettings

Represents the Omni-Channel settings for an org.

This type extends Metadata and inherits its fields.

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

OmniChannelSettings values are stored in the OmniChannel.settings file in the settings folder.

Introduced in API version 44.0.

• Type: boolean

• Required: No

• Introduced: API version 47.0

• Description: 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.

• Type: boolean
• Required: No
• Description: 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.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Indicates whether Secondary Routing Priority is enabled in your org. The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether skills-based routing is enabled in your org. The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether the status based capacity model for rep work is enabled or not. The default value is false.

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>

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.