Skip to content

Permission Sets

Config key: settings.permissionSets

Prerequisites

  • Omni-Channel enabled

Gives Permission Sets access to service presence statuses (Omni-Channel), by the API names of the statuses.

Screenshot

Permission Sets

Pill Field
1 [0].permissionSetName
2 [0].servicePresenceStatuses

Use cases

Support agents get the presence statuses of their team

Omni-Channel agents choose a presence status, such as "Available for cases" or "On a break", in the Omni-Channel widget, and they only see the statuses their profile or permission sets give access to. Litware gives them through the permission set of its support agents, and adds a status each time a new channel opens.

The access of a permission set to service presence statuses is not part of the PermissionSet metadata. This config moves the statuses TestStatus and TestStatus2 (the API names of the statuses, here those of the test fixtures of this plugin) to the enabled statuses of the permission set, and removes the ones not listed.

{
  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
  "settings": {
    "permissionSets": [
      {
        "permissionSetName": "ServicePresenceTest",
        "servicePresenceStatuses": [
          "TestStatus",
          "TestStatus2"
        ]
      }
    ]
  }
}

Example

{
  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
  "settings": {
    "permissionSets": [
      {
        "permissionSetName": "Support_Agent",
        "servicePresenceStatuses": [
          "Available",
          "Busy"
        ]
      }
    ]
  }
}

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 Default
[].permissionSetName string Permission Set
The name of the Permission Set to modify
Required.
[].servicePresenceStatuses string[] Service Presence Statuses []
JSON Schema
{
  "default": [],
  "title": "Permission Sets",
  "description": "Gives Permission Sets access to service presence statuses (Omni-Channel), by the API names of the statuses.\n\n![Service Presence Statuses Access](https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/permission-sets/screenshot.webp)",
  "examples": [
    [
      {
        "permissionSetName": "Support_Agent",
        "servicePresenceStatuses": [
          "Available",
          "Busy"
        ]
      }
    ]
  ],
  "x-prerequisites": [
    "Omni-Channel enabled"
  ],
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "permissionSetName": {
        "type": "string",
        "title": "Permission Set",
        "description": "The name of the Permission Set to modify"
      },
      "servicePresenceStatuses": {
        "default": [],
        "title": "Service Presence Statuses",
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "permissionSetName"
    ]
  }
}

Source code of this setting