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’s 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 in all Salesforce orgs. The fields that pertain to Reports and Dashboards are available in all orgs, but fields that pertain to CRM Analytics are only available in orgs with CRM 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. |
| analyticsCalendarApp | boolean |
Indicates whether the Analytics Calendar app for Industry-dependent templates can be installed in this org (true) or not (false). Available in API version 49.0. Removed in API version 50.0. |
| autoInstallApps | boolean |
Indicates whether CRM Analytics apps can be auto-installed in this org (true) or not (false). Available in API version 54.0 and later. |
| canAccessAnalyticsViaAPI | 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. |
| canAnnotateDashboards | 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. |
| canEnableBYOMZeroDayScoring | boolean |
Indicates whether zero day scoring on user uploaded Einstein Discover model is enabled in this org (true) or not (false). Available in API version 54.0 and later. |
| canEnableLiveMetrics | boolean |
Indicates whether the Data Discovery live model metrics calculation feature is available in this org (true) or not (false). Available in API version 48.0 and 49.0. Removed in API version 50.0. |
| 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 Experience Builder sites 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 to 50.0. Removed in API version 51.0. |
| 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. |
| enableAnalyticsEncryption | boolean |
Indicates whether encryption is on for Analytics in this org (true) or not (false). Available in API version 48.0 and later. |
| enableAnalyticsSharingEnable | boolean |
Indicates whether the Analytics sharing is available in this org (true) or not (false). Available in API version 48.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. |
| enableAutonomousExperience | boolean |
Indicates whether Ask Salesforce for Data is enabled in this org (true) or not (false). Available as Beta in API version 54.0 and later. |
| enableAzureDLGen2OutputConnector | boolean |
Indicates whether the Azure DL Gen2 output connector is enabled in this org (true) or not (false). Available in API version 54.0 and later. |
| enableC360GlobalProfileData | boolean |
Indicates whether the Customer 360 data validation dashboard connector is available in this org (true) or not (false). Available in API version 48.0 or 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. |
| enableDashboardToPDFEnable | boolean |
Indicates whether a dashboard can be exported to a PDF in this org (true) or not (false). Available in API version 48.0 and later. |
| enableDataBlending | boolean |
Indicates whether the Analytics Explorer data blending feature is available in this org (true) or not (false). Available in API version 48.0 and 49.0. Removed in API version 50.0. |
| 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. |
| enableFirebirdEditor | boolean |
Indicates whether the Firebird editor is available in this org (true) or not (false). Available in API version 48.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 CRM 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. |
| enableLwcInDashboards | boolean |
Indicates whether Lightning Web Components are enabled for use in CRM Analytics Dashboards (true) or not (false). Available as Beta in API version 53.0. Removed for GA in API version 54.0. |
| 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. |
| enableNullDimension | boolean |
Indicates whether null values are supported as a grouping key value in a SAQL query in this org (true) or not (false). Available in API version 48.0 and later. |
| enableOrgCanViewTableau | boolean |
Indicates whether admins can enable Tableau dashboards in this org (true) or not (false). Available in API version 55.0 and later. |
| enableOrgHaMobileOfflineEnabled | boolean |
Indicates whether admins can enable mobile offline access in this org (true) or not (false). Available in API version 51.0 and later. |
| enableOrgHasWatchlistEnabled | boolean |
Indicates whether admins can turn on watchlists for assets in this org (true) or not (false). Available in API version 50.0 and later. |
| enablePowerInsights | boolean |
Indicates whether admins can turn on Power Insights for this org (true) or not (false). Removed in API version 51.0. |
| enableQueryLiveConnectors | boolean |
Indicates whether querying live connectors is available in this org (true) or not (false). Available in API version 48.0 and later. |
| enabledRecommendedReportTypePref | boolean |
Indicates whether recommended report types for Lightning Reports are available in this org (true) or not (false). Available in API version 54.0 and later. |
| enableRemoveFooterForRepDisplay | boolean |
Indicates whether the default disclaimer for the report run page and printable view page is 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 removed (true) or not (false) in this org. Available in API version 47.0 and later. |
| enableReportField��ToFieldPref | 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. Removed in API version 48.0. |
| enableReportCrtAutoAddPref | boolean |
Indicates whether the feature to automatically add new fields to relevant custom Lightning Experience report types when they’re created is available in this org (true) or not (false). Available in API version 50.0 and 51.0. Removed in API version 52.0. |
| enableReportHideXlsExportPref | boolean |
Indicates whether the XLS export feature for Lightning Experience Reports is visible in this org (true) or not (false). Available in API version 51.0 and later. |
| enableReportInlineEditPref | boolean |
Indicates whether the inline editing feature for Lightning Experience Reports is available in this org (true) or not (false). Available in API version 53.0 and later. |
| enableReportNotificationsEnable | boolean |
Indicates whether the notification feature for Lightning Experience Reports is available in this org (true) or not (false). Available in API version 48.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. Removed in API version 48.0. |
| enableRequestPrioritySchdl | boolean |
Indicates whether priority-based dataflow request scheduling is available in this org (true) or not (false). Available in API version 50.0 and later. |
| enableS1AnalyticsEclairEnable | boolean |
Indicates whether EclairNG charts can be enabled for S1 Mobile Analytics in this org (true) or not (false). Available in API version 48.0 and later. |
| enableS3OutputConnector | boolean |
Indicates whether the S3 output data connector is available in this org (true) or not (false). Available in API version 49.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. |
| enableSalesforceOutputConnector | boolean |
Indicates whether the Salesforce output data connector is available in this org (true) or not (false). Available in API version 51.0 and later. |
| enableSecureImageSharing | boolean |
Indicates whether secure image sharing and downloading is enabled for this org (true) or not (false). Available in API version 50.0 and later. |
| enableSmartDataDiscovery | boolean |
Indicates whether the org admin can enable Einstein Discovery in this org (true) or not (false). Available in API version 49.0 and 50.0. Removed in API version 51.0. |
| enableSnowflakeOutputConnector | boolean |
Indicates whether the Snowflake output data connector is available in this org (true) or not (false). Available in API version 49.0 and later. |
| enableSqlDataset | boolean |
Indicates whether SQL datasets are available in this org (true) or not (false). Available in API version 52.0. Removed in API version 53.0. |
| enableSqlLiveDataset | boolean |
Indicates whether SQL live datasets are available in this org (true) or not (false). Available in API version 51.0 and 52.0. Removed in API version 53.0. |
| enableTableauHyperOutputConnector | boolean |
Indicates whether the Tableau hyper output data connector is available in this org (true) or not (false). Available in API version 51.0 and later. |
| 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. |
| enableWaveAssetsNewDateVersion | boolean |
Indicates whether the new date version for timezone support in Analytics assets is enabled in this org (true) or not (false). Available in API version 51.0 and later. |
| enableWaveCustomFiscal | boolean |
Indicates whether custom fiscal year is enabled for Analytics in this org (true) or not (false). When enabled, custom fiscal year lets admins import custom fiscal year definitions from Salesforce to Analytics. Available in API version 50.0 and later. |
| enableWaveIndexMVDim | boolean |
Indicates whether multi-value dimension indexing is enabled in this org (true) or not (false). Available in API version 50.0 and later. |
| enableWaveIndexMVDimV2 | boolean |
Indicates whether multi-value dimension indexing is enabled in this org (true) or not (false). Available in API version 52.0 and later. |
| enableWaveLwcDashboards | boolean |
Indicates whether embedded Analytics dashboards are rendered in Lightning Experience using a Lightning Web Component (true) or the legacy Aura Component (false). Available in API version 55.0 and later. |
| enableWaveRecordNavigation | boolean |
Indicates whether browser tab navigation for record actions from Analytics is enabled in this org (true) or not (false). Available in API version 48.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). |
| enableWaveSqlInQueryApi | boolean |
Indicates whether SQL is enabled for CRM Analytics in the Query API in this org (true) or not (false). Available as Beta in API version 53.0. Removed for GA in API version 54.0. |
| enableWaveTemplate | boolean |
Indicates whether Analytics templates are enabled for this org (true) or not (false). Removed in API version 51.0. |
| enableWaveTrendedDatasetCleanup | boolean |
Indicates whether this org allows automatic deletion of inactive trended datasets (true) or not (false). Available in API version 47.0 to 50.0. Removed in API version 51.0. |
| enableCreateLegacyDataflows | boolean |
Indicates whether access to creating dataflows is available in this org (true) or not (false). Available in API version 55.0 and later. |
| inheritSharingForNonOpptyObjects | boolean |
Indicates whether medium visibility support for Analytics sharing inheritance for all Salesforce objects besides the Opportunity object is available in this org (true) or not (false). Available in API version 48.0 and 49.0. Removed in API version 50.0. |
| inheritSharingForOpptyObject | boolean |
Indicates whether medium visibility support for Analytics sharing inheritance for the Opportunity object is available in this org (true) or not (false). Available in API version 48.0 and 49.0. Removed in API version 50.0. |
| maxHoursAppInProgress | integer |
The maximum number of hours an embedded application can have the status InProgress before it’s canceled. Available in API version 50.0 and later. |
| recipeDirectDataPref | boolean |
Indicates whether the option to enable Data Prep recipe direct data loading is available (true) or not (false). Available in API version 53.0 and later. |
| recipeFiscalPref | boolean |
Indicates whether the option to enable Data Prep recipe custom fiscal settings is available (true) or not (false). Available in API version 53.0 and later. |
| recipePreCachingOptOut | boolean |
Indicates whether the option to disable Data Prep recipe prestep caching is available (true) or not (false). Available in API version 53.0 and later. |
| recipeStagedDataPref | boolean |
Indicates whether staged data for Data Prep recipes is available in this org (true) or not (false). Available in API version 53.0 and later. |
| replaceBlankMeasuresWithNulls | boolean |
Indicates whether null values are supported in measures (true) or not (false). If enabled (true), the implicit default value for blank measures is null. Available in API version 48.0 and later. |
| setWaveIsYearEndFiscalYear | boolean |
Indicates whether the Analytics year end is the fiscal year end (true) or not (false). This preference is only applicable when enableWaveCustomFiscal is true. If false, the fiscal year end is the calendar year end. Available in API version 50.0 and later. |
| sonic��Enabled | boolean |
Indicates whether the Sonic feature is available in this org (true) or not (false). Available in API version 51.0 and later. |
| turnOnTimeZones | boolean |
Indicates whether the timezone feature is available in this org (true) or not (false). Available in API version 48.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.