Skip to content

Service Channels

Config key: settings.serviceChannels

Prerequisites

  • Omni-Channel enabled, with the status-based capacity model (omniChannelSettings)

Configures the capacity model of Service Channels (Omni-Channel): status-based capacity, the status field and its in-progress values.

Screenshot

Service Channels

Pill Field
1 [0].capacity.capacityModel
2 [0].capacity.statusField
3 [0].capacity.valuesForInProgress
4 [0].capacity.checkAgentCapacityOnReopenedWorkItems
5 [0].capacity.checkAgentCapacityOnReassignedWorkItems

Use cases

Case capacity follows the status of the case

Litware turned on the status-based capacity model in omniChannelSettings. Its case channel still uses the tab-based capacity model, so the change has no effect yet: each case channel must say which field tells the status of the work and which of its values mean "in progress".

This config switches the channel to status-based capacity on the Status field of the case, counts New, Working and Escalated cases as in progress, and checks the agent's capacity again when a closed case is reopened or a case is reassigned. The ServiceChannel metadata of the API versions most projects deploy with has no capacity fields, so the deployment of the channel is followed by this config.

{
  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
  "settings": {
    "serviceChannels": [
      {
        "serviceChannelDeveloperName": "CaseTest",
        "capacity": {
          "capacityModel": "StatusBased",
          "statusField": "Case.Status",
          "valuesForInProgress": [
            "New",
            "Working",
            "Escalated"
          ],
          "checkAgentCapacityOnReopenedWorkItems": true,
          "checkAgentCapacityOnReassignedWorkItems": true
        }
      }
    ]
  }
}

Example

{
  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
  "settings": {
    "serviceChannels": [
      {
        "serviceChannelDeveloperName": "Case",
        "capacity": {
          "capacityModel": "StatusBased",
          "statusField": "Case.Status",
          "valuesForInProgress": [
            "Working"
          ]
        }
      }
    ]
  }
}

Fields

In the field paths, [] stands for the items of a list and * for the entries of an object keyed by name.

Field Type Description Values
[].serviceChannelDeveloperName string Service Channel
The developer name of the Service Channel to modify
Required.
[].capacity.capacityModel string Capacity Model
Choose the service channel Capacity Model
TabBased
StatusBased
[].capacity.statusField string Status Field
API Name of the field used to track status
[].capacity.valuesForInProgress string[] Values for In-Progress
Choose the field values for In-Progress work
[].capacity.checkAgentCapacityOnReopenedWorkItems boolean Check agent capacity on reopened work items
[].capacity.checkAgentCapacityOnReassignedWorkItems boolean Check agent capacity on reassigned work items
JSON Schema
{
  "default": [],
  "title": "Service Channels",
  "description": "Configures the capacity model of Service Channels (Omni-Channel): status-based capacity, the status field and its in-progress values.\n\n![Service Channel capacity](https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/service-channels/screenshot.webp)",
  "examples": [
    [
      {
        "serviceChannelDeveloperName": "Case",
        "capacity": {
          "capacityModel": "StatusBased",
          "statusField": "Case.Status",
          "valuesForInProgress": [
            "Working"
          ]
        }
      }
    ]
  ],
  "x-prerequisites": [
    "Omni-Channel enabled, with the status-based capacity model (omniChannelSettings)"
  ],
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "serviceChannelDeveloperName": {
        "type": "string",
        "title": "Service Channel",
        "description": "The developer name of the Service Channel to modify"
      },
      "capacity": {
        "type": "object",
        "properties": {
          "capacityModel": {
            "type": "string",
            "enum": [
              "TabBased",
              "StatusBased"
            ],
            "title": "Capacity Model",
            "description": "Choose the service channel Capacity Model"
          },
          "statusField": {
            "type": "string",
            "title": "Status Field",
            "description": "API Name of the field used to track status"
          },
          "valuesForInProgress": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "title": "Values for In-Progress",
            "description": "Choose the field values for In-Progress work"
          },
          "checkAgentCapacityOnReopenedWorkItems": {
            "type": "boolean",
            "title": "Check agent capacity on reopened work items",
            "description": "Check agent capacity on reopened work items"
          },
          "checkAgentCapacityOnReassignedWorkItems": {
            "type": "boolean",
            "title": "Check agent capacity on reassigned work items",
            "description": "Check agent capacity on reassigned work items"
          }
        },
        "title": "Capacity Settings",
        "if": {
          "required": [
            "capacityModel"
          ],
          "properties": {
            "capacityModel": {
              "const": "StatusBased"
            }
          }
        },
        "then": {
          "required": [
            "statusField",
            "valuesForInProgress"
          ]
        },
        "else": {
          "if": {
            "required": [
              "capacityModel"
            ],
            "properties": {
              "capacityModel": {
                "const": "TabBased"
              }
            }
          },
          "then": {
            "not": {
              "anyOf": [
                {
                  "required": [
                    "statusField"
                  ]
                },
                {
                  "required": [
                    "valuesForInProgress"
                  ]
                }
              ]
            }
          }
        }
      }
    },
    "required": [
      "serviceChannelDeveloperName"
    ]
  }
}

Source code of this setting