RecordAlertDataSource

Represents an internal or external source for record alert data. This object is available in API version 54.0 and later.

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

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

ApexClass

Field Type: string
Description: The Apex class to be used as the data source.

This class must implement the fscwmgen.RecordAlertProvider interface.
Note

ApexClassId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The ID of the Apex class to be used as the data source.

This class must implement the fscwmgen.RecordAlertProvider interface.
Note

This is a relationship field.
Relationship Name: ApexClass
Relationship Type: Lookup
Refers To: ApexClass

DeveloperName

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

FullName

Type: string
Properties: Create, Group, Nillable
Description: Full name of the associated metadata type in Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive

Type: boolean
Properties: Defaulted on create, Filter, Group, Nillable, Sort
Description: Indicates whether the data source is still active (true) or not (false). There can only be one active data source at a time.
Default value: false

Language

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: Language of the record alert data source.
Possible values:
- da—Danish
- de—German
- en_US—English
- es—Spanish
- es_MX—Spanish (Mexico)
- fi—Finnish
- fr—French
- it—Italian
- ja—Japanese
- ko—Korean
- nl_NL—Dutch
- no—Norwegian
- pt_BR—Portuguese (Brazil)
- ru—Russian
- sv—Swedish
- th—Thai
- zh_CN—Chinese (Simplified)
- zh_TW—Chinese (Traditional)

ManageableState

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package.
Possible values:
- beta—Managed-Beta
- deleted—Managed-Proposed-Deleted
- deprecated—Managed-Proposed-Deprecated
- deprecatedEditable—SecondGen-Installed-Deprecated
- installed—Managed-Installed
- installedEditable—SecondGen-Installed-Editable
- released—Managed-Released
- unmanaged—Unmanaged

MasterLabel

Type: string
Properties: Filter, Group, idLookup, Nillable, Sort
Description: Label of the record alert data source.

Metadata

Type: complexvalue
Properties: Create, Nillable, Update
Description: Record alert data source metadata.

NamespacePrefix

Type: string
Properties: Filter, Group, Nillable, Sort
Description: Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.

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:
- APEX
- BusinessRulesEngine