---
schema_version: "1"
id: ff080521670cb42c391a4eb3aaa00daa6ac39729194178a0ba46cfabc92961a6
title: OmniChannelSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_omnichannelsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_omnichannelsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 67f82c0fae06cf9f1f201678bcf7c15474bf451b2dadaf174d53d5ea8c4beefe
description: Represents the Omni-Channel settings for an org.
---
# OmniChannelSettings

Represents the Omni-Channel settings for an org.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") 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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d715517e103">Field Name</th>

              <th class="featureTableHeader  " id="d715517e106">Field Type</th>

              <th class="featureTableHeader  " id="d715517e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniAutoLoginPrompt</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">
                <p class="p">Indicates whether to display a login confirmation upon loading a console with
                  Omni-Channel. The default value is <samp class="codeph java">false</samp>.</p>

                <p class="p">When <samp class="codeph nolang">true</samp>, 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.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniChannel</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="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 <samp class="codeph java">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniSecondaryRoutingPriority</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether Secondary Routing Priority is enabled in your org. The
                default value is <samp class="codeph java">false</samp>. Available in API version
                47.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniSkillsRouting</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether skills-based routing is enabled in your org. The default
                value is <samp class="codeph java">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d715517e103" data-title="Field Name"><span class="keyword parmname">enableOmniStatusCapModel</span></td>

              <td class="entry" headers="d715517e106" data-title="Field Type">boolean</td>

              <td class="entry" headers="d715517e109" data-title="Description">Indicates whether the status based capacity model for rep work is enabled or
                not. The default value is <samp class="codeph java">false</samp>.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a OmniChannelSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<OmniChannelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableOmniChannel\>true</enableOmniChannel\>
    <enableOmniAutoLoginPrompt\>true</enableOmniAutoLoginPrompt\>
    <enableOmniSecondaryRoutingPriority\>true</enableOmniSecondaryRoutingPriority\>
    <enableOmniSkillsRouting\>true</enableOmniSkillsRouting\>
</OmniChannelSettings\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>OmniChannel</members\>
        <name\>Settings</name\>
    </types\>
    <version\>44.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").