IncidentMgmtSettings

Represents settings for Customer Service Incident Management and Broadcast Communications.

Parent Type

This type extends Metadata and inherits its fields.

Manifest Access

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

IncidentMgmtSettings values are stored in the IncidentMgmt.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version

Introduced in API version 54.0.

Special Access Rules

IncidentMgmtSettings requires a Service Cloud license.

Fields

enableAiKnowledgeCreation

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the ITSM Knowledge Creation feature is enabled (true) or disabled (false) for your org. The default value is false.

enableAlertBroadcastType

Type: boolean
Required: No
Introduced: API version 57.0
Description: Indicates whether broadcast communication alerts are enabled (true) or disabled (false) for your org. Lets incident managers send disruptive in-app notifications when an incident occurs. The default value is false.

enableAssetHealthOnPortal

Type: boolean
Required: No

enableAssignedGroupValidation

Type: boolean
Required: No

enableAutoClosureOfChildIncident

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Automatically Close Child Incidents feature is enabled (true) or disabled (false) for your org. The default value is false.

enableAutoCreationOfProblem

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the automatic creation of problem record feature is enabled (true) or disabled (false) for your org. This setting automates creation of a problem record when an incident is approved as a major incident. The default value is false.

enableBroadcastCommOnChgReq

Type: boolean
Required: No

enableBroadcastCommOnIncident

Type: boolean
Required: No

enableBroadcastCommunication

Type: boolean
Required: No

enableChangePriorityMatrix

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false.

enableChangePriorityOverride

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Manual Priority Override feature is enabled (true) or disabled (false) for your org. The default value is false.

enableChangeRequestValidations

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Change Request Validations feature is enabled (true) or disabled (false) for your org. The default value is false.

enableChatToIncidentAi

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Chat and Voice to Incident with Al feature is enabled (true) or disabled (false) for your org. The default value is false.

enableChgCnfcltForMaintSchd

Type: boolean
Required: No

enableChgCnflctForChgOwner

Type: boolean
Required: No

enableChgCnflctForCnfgItems

Type: boolean
Required: No

enableChgCnflctForMoratSchd

Type: boolean
Required: No

enableChgRqstCnflctDetection

Type: boolean
Required: No

enableCnfgItemCopyForRecords

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the feature is enabled (true) or disabled (false) for your org. The default value is false.

enableDedupE2IncidentAttachment

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the delete duplicate email attachments feature is enabled (true) or disabled (false) for your org. The default value is false.

enableEmailBroadcastType

Type: boolean
Required: No
Introduced: API version 56.0
Description: Indicates whether broadcast communication emails are enabled (true) or disabled (false) for your org. Lets users send an email with critical information to impacted customers. The default value is false.

enableEmailToIncident

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Email-to-Incident feature is enabled (true) or disabled (false) for your org. The default value is false.

enableEmailToIncidentAi

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Email-to-Incident with Al feature is enabled (true) or disabled (false) for your org. The default value is false.

enableEmployeeServiceSlack

Type: boolean
Required: No

enableEmployeeServiceTeams

Type: boolean
Required: No

enableEnterpriseKnowledge

Type: boolean
Required: No

enableHtmlEmailToIncident

Type: boolean
Required: No

enableIncidentDraftEmails

Type: boolean
Required: No

enableIncidentMgmt

Type: boolean
Required: No
Introduced: API version 54.0
Description: Indicates whether Customer Service Incident Management is enabled (true) or disabled (false) for your org. Customer Service Incident Management is a Service Cloud solution that helps your teams track large-scale disruptions and delegate tasks to the right experts to ensure that your business delivers on customer expectations. The default value is true.

enableIncidentSigPos

Type: boolean
Required: No

enableIncidentValidations

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Incident Field Validations feature is enabled (true) or disabled (false) for your org. The default value is false.

enableIncPriorityMatrix

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false.

enableIncPriorityOverride

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Manual Priority Override for Incident feature is enabled (true) or disabled (false) for your org. The default value is false.

enableITSMChangeMgmt

Type: boolean
Required: No
Introduced: API version 63.0
Description: Indicates whether the ITSM Change Management feature is enabled (true) or disabled (false) for your org. The default value is false.

enableITSMChgDashboard

Type: boolean
Required: No

enableITSMFulfillerTeams

Type: boolean
Required: No

enableITSMHomeDashboard

Type: boolean
Required: No

enableITSMHomeFulDashboard

Type: boolean
Required: No

enableITSMIncFulDashboard

Type: boolean
Required: No

enableITSMIncidentMgmt

Type: boolean
Required: No
Introduced: API version 63.0
Description: Indicates whether the ITSM Incident Management feature is enabled (true) or disabled (false) for your org. The default value is false.

enableITSMIncMgrDashboard

Type: boolean
Required: No

enableITSMMajorIncParent

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Major Incident Management Parent Incident feature is enabled (true) or disabled (false) for your org. The default value is false.

enableITSMPrbFulDashboard

Type: boolean
Required: No

enableITSMPrbMgrDashboard

Type: boolean
Required: No

enableITSMProblemMgmt

Type: boolean
Required: No
Introduced: API version 63.0
Description: Indicates whether the ITSM Problem Management feature is enabled (true) or disabled (false) for your org. The default value is false.

enableITSMTeams

Type: boolean
Required: No

enableMiawForRequestorAgent

Type: boolean
Required: No

enablePrivilegeAssignment

Type: boolean
Required: No

enableProactiveCustomerOps

Type: boolean
Required: No

enableProactiveServiceOpsAutoCloseCases

Type: boolean
Required: No

enableProactiveServiceOpsNotifyAllContacts

Type: boolean
Required: No

enableProblemValidations

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Problem Field Validations feature is enabled (true) or disabled (false) for your org. The default value is false.

enableProbPriorityMatrix

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Automatic Priority Assignment for IT Service feature is enabled (true) or disabled (false) for your org. The default value is false.

enableProbPriorityOverride

Type: boolean
Required: No
Introduced: API version 65.0
Description: Indicates whether the Manual Priority Override feature is enabled (true) or disabled (false) for your org. The default value is false.

enableRiskAssessment

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Risk Assessment feature is enabled (true) or disabled (false) for your org. The default value is false.

enableRtaIncidentDescription

Type: boolean
Required: No

enableSaveE2IncidentAttachment

Type: boolean
Required: No
Introduced: API version 64.0
Description: Indicates whether the Save Email to Incident Attachment feature is enabled (true) or disabled (false) for your org. The default value is false.

enableSiteBannerBroadcastType

Type: boolean
Required: No
Introduced: API version 56.0
Description: Indicates whether broadcast communication for site banners is enabled (true) or disabled (false) for your org. Lets users add a banner with critical information to your Aura and LWR sites. The default value is false.

enableSlackBroadcastType

Type: boolean
Required: No
Introduced: API version 57.0
Description: Indicates whether broadcast communication Slack messages are enabled (true) or disabled (false) for your org. Lets incident managers send broadcasts to Slack when an incident occurs. The default value is false.

itServiceEnablement

Type: boolean
Required: No

notifySenderE2IErr

Type: boolean
Required: No

Declarative Metadata Sample Definition

The following is an example of an IncidentMgmtSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<IncidentMgmtSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableAiKnowledgeCreation>true</enableAiKnowledgeCreation>
4	<enableAlertBroadcastType>false</enableAlertBroadcastType>
5	<enableAutoClosureOfChildIncident>true</enableAutoClosureOfChildIncident>
6	<enableAutoCreationOfProblem>false</enableAutoCreationOfProblem>
7	<enableChangePriorityMatrix>true</enableChangePriorityMatrix>
8	<enableChangePriorityOverride>false</enableChangePriorityOverride>
9	<enableChangeRequestValidations>true</enableChangeRequestValidations>
10	<enableChatToIncidentAi>true</enableChatToIncidentAi>
11	<enableCnfgItemCopyForRecords>false</enableCnfgItemCopyForRecords>
12	<enableDedupE2IncidentAttachment>true</enableDedupE2IncidentAttachment>
13	<enableEmailBroadcastType>true</enableEmailBroadcastType>
14	<enableEmailToIncident>true</enableEmailToIncident>
15	<enableEmailToIncidentAi>false</enableEmailToIncidentAi>
16	<enableITSMChangeMgmt>true</enableITSMChangeMgmt>
17	<enableITSMIncidentMgmt>true</enableITSMIncidentMgmt>
18	<enableITSMMajorIncParent>true</enableITSMMajorIncParent>
19	<enableITSMProblemMgmt>false</enableITSMProblemMgmt>
20	<enableIncPriorityMatrix>true</enableIncPriorityMatrix>
21	<enableIncPriorityOverride>false</enableIncPriorityOverride>
22	<enableIncidentMgmt>true</enableIncidentMgmt>
23	<enableIncidentValidations>true</enableIncidentValidations>
24	<enableProbPriorityMatrix>true</enableProbPriorityMatrix>
25	<enableProbPriorityOverride>false</enableProbPriorityOverride>
26	<enableProblemValidations>true</enableProblemValidations>
27	<enableRiskAssessment>true</enableRiskAssessment>
28	<enableSaveE2IncidentAttachment>true</enableSaveE2IncidentAttachment>
29	<enableSiteBannerBroadcastType>false</enableSiteBannerBroadcastType>
30	<enableSlackBroadcastType>true</enableSlackBroadcastType>
31</IncidentMgmtSettings>

The following is an example package.xml that references the previous definition.

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

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!