Metadata API Developer Guide
jNewer Version Available
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 |
|---|---|---|
| enableOmniChannel | boolean | Indicates whether Omni-Channel is enabled, giving you access to the objects needed to set up the feature in your org. |
| enableOmniSkillsRouting | boolean | Indicates whether skills-based routing is enabled in your org. |
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 <enableOmniSkillsRouting>true</enableOmniSkillsRouting>
5</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>