RecordAlertCategory

Represents a category to group and present record alerts.

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

Parent Type

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

File Suffix and Directory Location

RecordAlertCategory components have the suffix recordAlertCategory and are stored in the recordAlertCategories folder.

Version

RecordAlertCategory components are available in API version 54.0 and later.

Fields

Field Name Description
description
Field Type
string
Description
The description of the record alert category.
masterLabel
Field Type
string
Description

Required.

The user-interface name of the record alert category.
severity
Field Type
string
Description
Indicates the degree of impact that an alert in this category can have.
Possible Education Cloud values are:
  • High
  • Low
  • Medium
Possible Financial Service Cloud values are:
  • Error
  • Info
  • Minor
  • Warning

Declarative Metadata Sample Definition

The following is an example of a RecordAlertCategory component.

<?xml version="1.0" encoding="UTF-8"?>
<RecordAlertCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>Tracks Financial Account Fraud Alerts</description>
    <masterLabel>Fraud</masterLabel>
    <severity>Error</severity>
</RecordAlertCategory>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Fraud</members>
        <name>RecordAlertCategory</name>
    </types>
    <version>54.0</version>
</Package>

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.