Newer Version Available

This content describes an older version of this product. View Latest

OmniSupervisorConfig

Represents the Omni-Channel supervisor configuration for an assigned group of supervisors. This object is available in API version 57.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To access this object, Omni-Channel must be enabled. Access to tooling objects requires Salesforce admin privileges or the Customize Application permission.

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the associated metadata type in Metadata API. The full name can include a namespace prefix.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsTimelineHidden
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If set to true, hides the agent timeline from the supervisors assigned to this supervisor configuration. The default value is false.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Possible values are the languages that Omni-Channel supports.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The label of the Omni-Channel supervisor configuration.
Metadata
Type
mns:OmniSupervisorConfig
Properties
Create, Nillable, Update
Description
The Omni-Channel supervisor configuration’s metadata.
SkillVisibility
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Determines which work items based on skills are visible to the supervisors assigned to this supervisor configuration. Possible values are:
  • AllSkills—Show work items with all skill requirements selected in this supervisor configuration.
  • AnySkill—Show work items with at least one skill requirement selected in this supervisor configuration.