Metadata API Developer Guide
jNewer Version Available
AnalyticsSettings
File Suffix and Directory Location
AnalyticsSettings values are stored in the Analytics.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
AnalyticsSettings components are available in API version 46.0 and later.
Special Access Rules
The AnalyticsSettings metadata type is accessible only in orgs with Einstein Analytics enabled.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| alwaysGenPreviews | boolean |
Indicates whether Analytics asset previews are generated (true) or not (false). Available in API version 47.0 and later. |
| analyticsAdoptionMetadata | boolean |
Indicates whether Adoption Analytics metadata collection can be installed via a dataflow in this org (true) or not (false). Available in API version 47.0 and later. |
| canAccessAnaltyicsViaAPI | boolean |
Indicates whether Analytics assets can be accessed via the Analytics REST API in this org (true) or not (false). Available in API version 47.0 and later. |
| canAnnotateDashboard | boolean |
Indicates whether the Analytics dashboards Chatter annotation feature is available in this org (true) or not (false). Available in API version 47.0 and later. |
| canEnableSavedView | boolean |
Indicates whether the saved view feature for Analytics dashboards is available in this org (true) or not (false). Available in API version 47.0 and later. |
| canExploreDataConversationally | boolean |
Indicates whether Analytics data can be explored via NLQ (true) rather than using strict SAQL statements (false). For example, "Show me all accounts that are closed won". Available in API version 47.0 and later. |
| canShareAppsWithCommunities | boolean |
Indicates whether Analytics apps can be shared with Communities and their users, outside of the standard Analytics Studio experience (true) or not (false). Available in API version 47.0 and later. |
| canSubscribeDashboardWidgets | boolean |
Indicates whether a user can subscribe to Analytics dashboard widgets in this org (true) or not (false). Available in API version 47.0 and later. |
| canViewThumbnailAssets | boolean |
Indicates whether the thumbnail representations of Analytics lenses and dashboards are viewable (true) or not (false). Available in API version 47.0 and later. |
| enableAnalyticsSubtotals | boolean |
Indicates whether the Analytics subtotals feature is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enableAutoCompleteCombo | boolean |
Indicates whether using auto-complete when choosing reports and dashboards is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enableDashboardComponentSnapshot | boolean |
Indicates whether posting dashboard component snapshots to feeds that are visible to all users is enabled in this org (true) or not (false). Available in API version 47.0 and later. |
| enableDashboardFlexiTable | boolean |
Indicates whether access is enabled to flexible dashboard tables for all users in this org (true) or not (false). Available in API version 47.0 and later. |
| enableEmailReportsToPortalUsers | boolean |
Indicates whether this org allows Classic reports and dashboards to be sent to Portal Users (true) or not (false). Available in API version 47.0 and later. |
| enableFloatingReportHeaders | boolean |
Indicates whether report results display floating headers when scrolling (true) or not (false). Available in API version 47.0 and later. |
| enableInsights | boolean |
Indicates whether Einstein Analytics is enabled for this org (true) or not (false). |
| enableLightningReportBuilder | boolean |
Indicates whether the Lightning Report Builder feature can be enabled or disabled on the Setup page in this org (true) or not (false). Available in API version 47.0 and later. |
| enableLotusNotesImages | boolean |
Indicates whether the use of Lotus Notes-friendly images in dashboards and report emails is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enableMassEnableReportBuilder | boolean |
Indicates whether the Report Builder can be enabled for the entire org (true), overriding profile level settings, or not (false). Available in API version 47.0 and later. |
| enableNewChartsEngine | boolean |
Indicates whether the New Charts Engine for reports and dashboards is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enablePowerInsights | boolean |
Indicates whether admins are enabled to turn on Power Insights for this org (true) or not (false). |
| enableRemoveFooterForRepDisplay | boolean |
Indicates whether the default disclaimer for the report run page and printable view page will be removed (true) or not (false) in this org. Available in API version 47.0 and later. |
| enableRemoveFooterFromRepExp | boolean |
Indicates whether the default footer from the exported (csv/excel) report will be removed (true) or not (false) in this org. Available in API version 47.0 and later. |
| enableReportFieldToFieldPref | boolean |
Indicates whether the field-to-field filters features in Lightning Experience Reports is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enableReportUniqueRowCountPref | boolean |
Indicates whether the unique row count aggregate feature in Lightning Experience Reports is available in this org (true) or not (false). Available in API version 47.0 and later. |
| enableSFXJoinedReportsEnable | boolean |
Indicates whether the Lightning joined report feature can be enabled or disabled on the Setup page in this org (true) or not (false). Available in API version 47.0 and later. |
| enableSmartDataDiscovery | boolean |
Indicates whether the org admin can enable Einstein Discovery in this org (true) or not (false). |
| enableUseOldChartsLookAndFeel | boolean |
Indicates whether this org allows old charts look and feel for reports and dashboards (true) or not (false). Available in API version 47.0 and later. |
| enableWaveReplication | boolean |
Indicates whether replication(extract) for Salesforce objects is enabled in this org (true) instead of SFDC Digest (false). |
| enableWaveSharingInheritance | boolean |
Indicates whether Analytics data can inherit sharing and security settings for their source Salesforce object in this org (true) or not (false). |
| enableWaveTemplate | boolean |
Indicates whether Analytics templates are enabled for this org (true) or not (false). |
| enableWaveTrendedDatasetCleanup | boolean |
Indicates whether this org allows automatic deletion of inactive trended datasets (true) or not (false). Available in API version 47.0 and later. |
Declarative Metadata Sample Definition
The following is an example of the Analytics.settings file:
1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableWaveTemplate>true</enableWaveTemplate>
4 <enableInsights>true</enableInsights>
5 <canAccessAnalyticsViaAPI>true</canAccessAnalyticsViaAPI>
6</AnalyticsSettings>Example Package Manifest
The following is an example package manifest used to deploy or retrieve the Analytics settings metadata:
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Analytics</members>
5 <name>Settings</name>
6 </types>
7 <version>47.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.