EventSettings

Represents an org’s platform event settings for Event Monitoring.

This type extends Metadata and inherits its fields.

EventSettings components have the suffix .settings and are stored in the settings folder.

Introduced in API version 47.0.

• Type: boolean
• Required: No
• Description: Determines the behavior of metering service protection for Transaction Security policies. When true, metering occurs but doesn’t block the user operation that triggered the policy. When false and a policy can’t be handled within three seconds, metering occurs and the user’s action is blocked. Default value is false.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) Apex Limit events.

• Type: boolean
• Required: No
• Description: Allows (true) or disallows (false) Apex limits. Default value is false.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the dynamic creation of a streaming channel when you subscribe to generic streaming. Default value is false.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the generation of event monitoring log files. Default value is false.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the integration of event monitoring log files and Analytics apps. Analytics apps help you visualize your user’s activity. Default value is false.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the generation of Lightning Logger events. Lightning Logger events track information about custom Lightning web components. Default value is false. Requires Salesforce Shield or Salesforce Event Monitoring add-on subscriptions.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the Login Forensics feature. Login Forensics helps you track and audit your org’s user login activity. Default value is false. Available in API versions 47.0–49.0.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) Platform Tracing in the org. Default value is true.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) Streaming API in the org. Default value is true.

• Type: boolean
• Required: No
• Description: Enables (true) or disables (false) the ability to create and use transaction security policies in the Salesforce UI. Default value is false.

• Type: int
• Required: No
• Description: Specifies the number of days (between 30 and 365) that your event log file data is retained for. If this value is not set, your event log file data is retained for 1 year by default.

The following is an example of an EventSettings.settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<EventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableDeleteMonitoringData>true</enableDeleteMonitoringData>
4    <enableDynamicStreamingChannel>false</enableDynamicStreamingChannel>
5    <enableEventLogWaveIntegration>true</enableEventLogWaveIntegration>
6    <enableStreamingApi>true</enableStreamingApi>
7    <enableTransactionSecurityPolicies>true</enableTransactionSecurityPolicies>
8</EventSettings>

The following is an example package manifest used to deploy or retrieve the Event settings metadata:

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

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.