--- schema_version: "1" id: a0799e1f76d91133c8610fbe0ea6c639c58840d71d0a5b5463274f5abf9d0210 title: OmniSupervisorConfig collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_omnisupervisorconfig.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_omnisupervisorconfig.htm source_site: developer.salesforce.com content_type: documentation content_hash: f800747df5037297bcebf8a3724603922d1f6890c5996846aaae7866021469f2 description: Represents the Omni-Channel supervisor configuration for an assigned group of supervisors. --- # OmniSupervisorConfig Represents the Omni-Channel supervisor configuration for an assigned group of supervisors. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location OmniSupervisorConfig components have the suffix .omniSupervisorConfig and are stored in the omniSupervisorConfigs folder. ## Version OmniSupervisorConfig components are available in API version 57.0 and later. ## Special Access Rules To access this type, [Omni-Channel](https://help.salesforce.com/articleView?id=omnichannel_intro.htm&language=en_US) must be enabled. ## Fields | Field Name | Description | | --- | --- | | isTimelineHidden | Field Type boolean Description Required. If set to true, hides the agent timeline from the supervisors assigned to this supervisor configuration. The default value is false. | | masterLabel | Field Type string Description Required. A unique label for the supervisor configuration. The name must begin with a letter and can contain alphanumeric characters and underscores. It can’t contain spaces, two consecutive underscores, or end with an underscore. The name appears as Omni Supervisor Configuration Name in the UI. | | omniSpvsrConfigAIAgent | Field Type [OmniSpvsrConfigAIAgent\[\]](#omniSpvsrConfigAIAgentID) Description Represents AI agent bots that are visible to supervisors in this configuration. This field is available in API version 64.0 and later. | | omniSupervisorConfigAction | Field Type [OmniSupervisorConfigAction\[\]](#omniSupervisorConfigActionID) Description Represents the actions available to the supervisors of this Omni-Channel supervisor configuration. | | omniSupervisorConfigGroup | Field Type [OmniSupervisorConfigGroup\[\]](#omniSupervisorConfigGroupID) Description Represents the group of agents who are visible to the supervisors of an Omni-Channel supervisor configuration. The group, if visible, appears in the Agents tab of Omni Supervisor. | | omniSupervisorConfigProfile | Field Type [OmniSupervisorConfigProfile\[\]](#omniSupervisorConfigProfileID) Description Represents the supervisor profiles to which an Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations. | | omniSupervisorConfigQueue | Field Type [OmniSupervisorConfigQueue\[\]](#omniSupervisorConfigQueueID) Description Represents the queues that are visible to the supervisors of an Omni-Channel supervisor configuration. The queue, if visible, appears in the Queues Backlog and Assigned Work tabs of Omni Supervisor. | | omniSupervisorConfigSkill | Field Type [OmniSupervisorConfigSkill\[\]](#omniSupervisorConfigSkillID) Description Represents the skills that are visible to the supervisors of an Omni-Channel supervisor configuration. These skills, if visible, appear in the Skills Backlog tab of Omni Supervisor. | | omniSupervisorConfigTab | Field Type [OmniSupervisorConfigTab\[\]](#omniSupervisorConfigTabID) Description Represents the visible tabs specified in an Omni Supervisor configuration. This object is available in API version 60.0 and later. | | omniSupervisorConfigUser | Field Type [OmniSupervisorConfigUser\[\]](#section_ocv_424_1fc) Description Represents the supervisor to which the Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations. This object is available in API version 64.0 and later. | | skillVisibility | Field Type OmniSuperSkillVisibilityType (enumeration of type string) Description Determines which work items based on skills are visible to the supervisors assigned to this supervisor configuration. Values are: - AllSkills - AnySkill | ## OmniSpvsrConfigAIAgent Represents AI agent bot definitions that are visible to supervisors in this configuration. This object is available in API version 64.0 and later. | Field Name | Description | | --- | --- | | botDefinition | Field Type string Description Required. The name of the bot definition that is visible to supervisors in this configuration. | ## OmniSupervisorConfigAction Represents an action and associated tab, custom flow, and display order for supervisor actions in this configuration. | Field Name | Description | | --- | --- | | actionName | Field Type OmniSupervisorActionName (enumeration of type string) Description Required. An action that a supervisor can perform. Values are: - AWSDashboard - AssignLearning - ChangeGroups - ChangeQueues - ChangeSkills - CustomAction - ManageQueues | | actionTab | Field Type OmniSupervisorActionTab (enumeration of type string) Description Required. The tab where the action appears. Values are: - AgentDetails - AllAgents - AssignedWork - AssignedWorkDetails - QueueDetails - QueuesBacklog - SkillDetails - SkillsBacklog | | customActionFlow | Field Type string Description A flow that performs a custom action. | | displayOrder | Field Type int Description Required. The order in which the action is displayed. | ## OmniSupervisorConfigGroup Represents the group of agents for the supervisors in this configuration. | Field Name | Description | | --- | --- | | group | Field Type string Description Required. The name of the group of agents. | ## OmniSupervisorConfigProfile Represents a profile for the supervisors in this configuration. | Field Name | Description | | --- | --- | | profile | Field Type string Description Required. The profile name. | ## OmniSupervisorConfigQueue Represents a queue that’s visible to the supervisors in this configuration. | Field Name | Description | | --- | --- | | queue | Field Type string Description Required. The queue name. | ## OmniSupervisorConfigSkill Represents a skill that’s visible to supervisors in this configuration. | Field Name | Description | | --- | --- | | skill | Field Type string Description Required. The skill name. | ## OmniSupervisorConfigTab Represents the visible tabs specified in an Omni Supervisor configuration. This object is available in API version 60.0 and later. | Field | Details | | --- | --- | | displayOrder | Type int Properties Create, Filter, Group, Nillable, Sort Description The order in which tabs are displayed in Omni Supervisor. | | flexipage | Type string Description The name of the [FlexiPage](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_flexipage.htm "html (New Window)") added as a customized tab. Required when tabTypeis set to FlexipageType. | | tabType | Type OmniSupervisorTabType (enumeration of type string) Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Required. Tabs shown on the Omni Supervisor page. Possible values are: - Agents — the Agents tab - AssignedWork — the Assigned Work tab - FlexipageType — A custom tab created using Lightning App Builder, with the omniSupervisorPageType value of the FlexiPage Type field - QueuesBacklog — the Queues Backlog tab - SkillsBacklog — the Skills Backlog tab - Wallboard — the Wallboard tab | ## OmniSupervisorConfigUser Represents the supervisor to which the Omni-Channel supervisor configuration applies. User-level configurations override profile-level configurations. This object is available in API version 64.0 and later. | Field | Details | | --- | --- | | user | Type string Description Required. Represents the supervisor to which the Omni-Channel supervisor configuration applies. | ## Declarative Metadata Sample Definition The following is an example of a OmniSupervisorConfig component. true Supervisor Config AllSkills ChangeQueues AllAgents 0 Agent\_Group contractmanager CaseQueue English The following is an example package.xml that references the previous definition. \* OmniSupervisorConfig 57.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. 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).