Skip to content

Omni-Channel Settings

Config key: settings.omniChannelSettings

Prerequisites

  • Omni-Channel enabled

Setup: Feature Settings → Service → Omni-Channel → Omni-Channel Settings (/lightning/setup/OmniChannelSettings/home)

Enables the status-based capacity model.

Screenshot

Omni-Channel Settings

Pill Field
1 enableStatusBasedCapacityModel

Use cases

A support center counts only the cases agents are working on

The support center of Litware routes cases to its agents with Omni-Channel. With the default tab-based capacity model, a case counts against an agent's capacity as long as its tab is open, so agents who park cases in "Waiting on customer" stop receiving new work while they have nothing to do.

The status-based capacity model counts a case only while its status says it is in progress, and frees the capacity as soon as the agent changes the status or the owner. It is a checkbox of the Omni-Channel Settings page with no Metadata API equivalent; turn it on with this config before configuring the capacity of the service channels with serviceChannels.

{
  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
  "settings": {
    "omniChannelSettings": {
      "enableStatusBasedCapacityModel": true
    }
  }
}

Fields

Field Type Description
enableStatusBasedCapacityModel boolean Enable Status-Based Capacity Model
Route and track work based on changes to work status and ownership.
JSON Schema
{
  "type": "object",
  "properties": {
    "enableStatusBasedCapacityModel": {
      "type": "boolean",
      "title": "Enable Status-Based Capacity Model",
      "description": "Route and track work based on changes to work status and ownership."
    }
  },
  "title": "Omni-Channel Settings",
  "description": "Setup: **Feature Settings → Service → Omni-Channel → Omni-Channel Settings** (`/lightning/setup/OmniChannelSettings/home`)\n\nEnables the status-based capacity model.\n\n![Omni-Channel Settings](https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/omni-channel-settings/screenshot.webp)",
  "examples": [
    {
      "enableStatusBasedCapacityModel": true
    }
  ],
  "x-prerequisites": [
    "Omni-Channel enabled"
  ]
}

Source code of this setting