RecordAlertDataSource | Industries Common Resources Developer Guide

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

RecordAlertDataSource components have the suffix recordAlertDataSource and are stored in the recordAlertDataSources folder.

Version

RecordAlertDataSource components are available in API version 54.0 and later.

Fields

Field Name	Description
apexClass	Field Type string Description The Apex class to be used as the data source. This class must implement the `fscwmgen.RecordAlertProvider` interface. Note
isActive	Field Type boolean Description Indicates whether this data source is still active (`true`) or not (`false`). There can only be one active data source at a time. Note The default is `false`.
isProtected	Field Type boolean Description An auto-generated value that doesn’t currently impact the behavior of the metadata type.
masterLabel	Field Type string Description Required. The user-interface name of the record alert category.
type	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of active data source used to fetch a record alert. This field is available in API version 55.0 and later. Possible values are: `APEX` `BusinessRulesEngine`

Declarative Metadata Sample Definition

The following is an example of a RecordAlertDataSource component.

1<?xml version="1.0" encoding="UTF-8"?>
2<RecordAlertDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>FeeInfo</masterLabel>
4    <apexClass>SalesforceProvider</apexClass>
5    <isActive>false</isActive>
6</RecordAlertDataSource>

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    <namespacePrefix>[namespacePrefix]</namespacePrefix>
4    <types>
5        <members>SalesforceProvider</members>
6        <name>ApexClass</name>
7    </types>
8    <types>
9        <members>*</members>
10        <name>RecordAlertDataSource</name>
11    </types>
12    <version>54.0</version>
13</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.