IncidentMgmtSettings | Metadata API Developer Guide

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

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

IncidentMgmtSettings components are available in API version 54.0 and later.

Special Access Rules

IncidentMgmtSettings requires a Service Cloud license.

Fields

Field Name	Description
enableAlertBroadcastType	Field Type boolean Description Indicates whether broadcast communication alerts are enabled (`true`) or not (`false`). Lets incident managers send disruptive in-app notifications when an incident occurs. Default is `false`. Available in API version 57.0 and later.
enableEmailBroadcastType	Field Type boolean Description Indicates whether broadcast communication emails are enabled (`true`) or not (`false`). Lets users send an email with critical information to impacted customers. Default is `false`. Available in API version 56.0 and later.
enableIncidentMgmt	Field Type boolean Description Indicates whether Customer Service Incident Management is enabled (`true`) or not (`false`). 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. Default is `true`. Available in API version 54.0 and later.
enableSiteBannerBroadcastType	Field Type boolean Description Indicates whether broadcast communication for site banners is enabled (`true`) or not (`false`). Lets users add a banner with critical information to your Aura and LWR sites. Default is `false`. Available in API version 56.0 and later.
enableSlackBroadcastType	Field Type boolean Description Indicates whether broadcast communication Slack messages are enabled (`true`) or not (`false`). Lets incident managers send broadcasts to Slack when an incident occurs. Default is `false`. Available in API version 57.0 and later.

Declarative Metadata Sample Definition

The following is an example of an IncidentMgmtSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AccountSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableAccountDiscovery>true</enableAccountDiscovery>
4	<enableAccountHistoryTracking>true</enableAccountHistoryTracking>
5	<enableAccountInsightsInMobile>false</enableAccountInsightsInMobile>
6	<enableAccountOwnerReport>true</enableAccountOwnerReport>
7	<enableAccountTeams>true</enableAccountTeams>
8	<enableContactHistoryTracking>true</enableContactHistoryTracking>
9	<enableRelateContactToMultipleAccounts>true</enableRelateContactToMultipleAccounts>
10	<showViewHierarchyLink>true</showViewHierarchyLink>
11</AccountSettings>

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.