OmniSupervisorConfig | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

OmniSupervisorConfig コンポーネントのサフィックスは .omniSupervisorConfig であり、omniSupervisorConfigs フォルダーに保存されます。

バージョン

OmniSupervisorConfig コンポーネントは、API バージョン 57.0 以降で使用できます。

特別なアクセスルール

この種別にアクセスするには、オムニチャネルが有効になっている必要があります。

項目

項目名	説明
isTimelineHidden	項目の型 boolean 説明必須。`true` に設定すると、このスーパーバイザー構成に割り当てられたスーパーバイザーで、エージェントのタイムラインが非表示になります。デフォルト値は `false` です。
masterLabel	項目の型 string 説明必須。このスーパーバイザー構成の一意のラベル。名前は文字で始まる必要があり、英数字とアンダースコアを使用できます。スペース、2 つの連続するアンダースコア、末尾のアンダースコアを使用することはできません。UI ではこの名前が、オムニスーパーバイザーの設定名として表示されます。
omniSupervisorConfigAction	項目の型 OmniSupervisorConfigAction[] 説明この Omni-Channel Supervisor 設定のスーパーバイザーが使用可能なアクションを表します。
omniSupervisorConfigGroup	項目の型 OmniSupervisorConfigGroup[] 説明 Omni-Channel Supervisor 設定のスーパーバイザーが参照可能なエージェントのグループを表します。グループが参照可能な場合は、オムニスーパーバイザーの [エージェント] タブに表示されます。
omniSupervisorConfigProfile	項目の型 OmniSupervisorConfigProfile[] 説明 Omni-Channel Supervisor 設定に適用されるスーパーバイザープロファイルを表します。ユーザーレベルの設定でプロファイルレベルの設定が上書きされます。
omniSupervisorConfigQueue	項目の型 OmniSupervisorConfigQueue[] 説明 Omni-Channel Supervisor 設定のスーパーバイザーが参照可能なキューを表します。キューが��照可能な場合は、オムニスーパーバイザーの [キューのバックログ] タブと [割り当てられた作業] タブに表示されます。
omniSupervisorConfigSkill	項目の型 OmniSupervisorConfigSkill[] 説明 Omni-Channel Supervisor 設定のスーパーバイザーが参照可能なスキルを表します。このスキルが参照可能な場合、オムニスーパーバイザーの [スキルのバックログ] タブに表示されます。
omniSupervisorConfigTab	項目の型 OmniSupervisorConfigTab[] 説明オムニスーパーバイザー設定で指定された表示可能なタブを表します。このオブジェクトは、API バージョン 60.0 以降で使用できます。
skillVisibility	項目の型 OmniSuperSkillVisibilityType (string 型の列挙) 説明このスーパーバイザー構成に割り当てられたスーパーバイザーに、どのワークアイテムをスキルに基づいて表示するかを決定します。値は次のとおりです。 `AllSkills` `AnySkill`

OmniSupervisorConfigAction

この設定のスーパーバイザーアクションに対するアクションと関連するタブ、カスタムフロー、表示順序を表します。

項目名	説明
actionName	項目の型 OmniSupervisorActionName (string 型の列挙) 説明必須。スーパーバイザーが実行可能なアクション。値は次のとおりです。 `AWSDashboard` `AssignLearning` `ChangeQueues` `ChangeSkills` `CustomAction` `ManageQueues`
actionTab	項目の型 OmniSupervisorActionTab (string 型の列挙) 説明必須。アクションが表示されるタブ。値は次のとおりです。 `AgentDetails` `AllAgents` `AssignedWork` `AssignedWorkDetails` `QueueDetails` `QueuesBacklog` `SkillDetails` `SkillsBacklog`
customActionFlow	項目の型 string 説明カスタムアクションを実行するフロー。
displayOrder	項目の型 int 説明必須。アクションが表示される順序。

OmniSupervisorConfigGroup

この設定におけるスーパーバイザーのエージェントのグループを表します。

項目名	説明
group	項目の型 string 説明必須。エージェントのグループの名前。

OmniSupervisorConfigProfile

この設定におけるスーパーバイザーのプロファイルを表します。

項目名	説明
profile	項目の型 string 説明必須。プロファイル名。

OmniSupervisorConfigQueue

この設定のスーパーバイザーが参照可能なキューを表します。

項目名	説明
queue	項目の型 string 説明必須。キュー名。

OmniSupervisorConfigSkill

この設定のスーパーバイザーが参照可能なスキルを表します。

項目名	説明
skill	項目の型 string 説明必須。スキル名。

OmniSupervisorConfigTab

オムニスーパーバイザー設定で指定された表示可能なタブを表します。このオブジェクトは、API バージョン 60.0 以降で使用できます。

項目	Details
displayOrder	型 int プロパティ Create、Filter、Group、Nillable、Sort 説明オムニスーパーバイザーでタブが表示される順番。
flexipage	型 string 説明カスタマイズタブとして追加された FlexiPage の名前。tabType が `FlexipageType` に設定されている場合は必須です。
tabType	型 OmniSupervisorTabType (string 型の列挙) プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort 説明必須。オムニスーパーバイザーのページに表示されるタブ。可能な値は次のとおりです。 `Agents` - [エージェント] タブ `AssignedWork` - [割り当てられた作業] タブ `FlexipageType` - Lightning アプリケーションビルダーを使用して作成されたカスタムタブ。FlexiPage `Type` 項目の `omniSupervisorPageType` 値を持つ `QueuesBacklog` - [キューのバックログ] タブ `SkillsBacklog` - [スキルのバックログ] タブ `Wallboard` - [ウォールボード] タブ

宣言的なメタデータの定義のサンプル

OmniSupervisorConfig コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniSupervisorConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <isTimelineHidden>true</isTimelineHidden>
4    <masterLabel>Supervisor Config</masterLabel>
5    <skillVisibility>AllSkills</skillVisibility>
6    <omniSupervisorConfigAction>
7        <actionName>ChangeQueues</actionName>
8        <actionTab>AllAgents</actionTab>
9        <displayOrder>0</displayOrder>
10    </omniSupervisorConfigAction>
11    <omniSupervisorConfigGroup>
12        <group>Agent_Group</group>
13    </omniSupervisorConfigGroup>
14    <omniSupervisorConfigProfile>
15        <profile>contractmanager</profile>
16    </omniSupervisorConfigProfile>
17    <omniSupervisorConfigQueue>
18        <queue>CaseQueue</queue>
19    </omniSupervisorConfigQueue>
20    <omniSupervisorConfigSkill>
21        <skill>English</skill>
22    </omniSupervisorConfigSkill>
23</OmniSupervisorConfig>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>OmniSupervisorConfig</name>
6    </types>
7    <version>57.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。