Metadata API Developer Guide
jNewer Version Available
OmniChannelSettings
Parent Type and Manifest Access
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all the settings metadata types for the org 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.
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. |
| enableOmniStatusCapModel | boolean | Indicates whether the status based capacity model for rep work is enabled or not. The default value is false. |
Declarative Metadata Sample Definition
The following is an example of a OmniChannelSettings component.
The following is an example package.xml that references the previous definition.
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.