Metadata Type: AnalyticsDashboard
AnalyticsDashboard is a metadata type in Salesforce (API v64.0+) that represents a Tableau Next dashboard asset. This type allows administrators and developers to declaratively manage, version, and deploy Tableau Next dashboards across Salesforce environments using the Metadata API.
Overview
The AnalyticsDashboard metadata type enables programmatic retrieval, deployment, and lifecycle management of Tableau Next dashboards as metadata. It supports CI/CD workflows, version control, and promotes consistent, repeatable analytics delivery. Each AnalyticsDashboard defines the composition, layout, and configuration of a Tableau Next dashboard, including references to its visualizations and data sources.
Key Features
- Declarative definition of Tableau Next dashboards as metadata assets
- Supports version-controlled deployment and retrieval via Metadata API (API v64.0+)
- References AnalyticsVisualization and AnalyticsWorkspace assets
- Facilitates CI/CD and automated analytics lifecycle management
Structure and Components
An AnalyticsDashboard metadata record typically includes the following components:
- fullName: The unique developer name for the dashboard asset
- definition: The JSON structure specifying the dashboard’s layout, visualizations, configuration, and interactivity
- workspace: Reference to the AnalyticsWorkspace (Tableau Next workspace) containing the dashboard
- visualizations: List of AnalyticsVisualization assets included in the dashboard
- description: (Optional) Text describing the dashboard’s business purpose or usage
Deployment Considerations
When deploying AnalyticsDashboard metadata, Salesforce administrators should keep these points in mind:
1. API Version Compatibility
AnalyticsDashboard requires API version 64.0 or higher. Earlier versions do not support Tableau Next dashboard assets.
2. Asset Dependencies
Ensure referenced AnalyticsWorkspace and AnalyticsVisualization assets exist in the target org or are included in the deployment package.
3. JSON Definition Validity
The definition field must contain valid JSON that adheres to the Tableau Next schema for dashboards. Errors in the JSON will cause deployment failures or runtime issues.
4. Permissions
The user deploying must have sufficient permissions for Tableau Next, Metadata API access, and related workspace and visualization assets.
5. Testing and Validation
Test new or updated dashboards in a sandbox to verify correct layout, data integration, and interactivity before production deployment.
Best Practices for Salesforce Administrators
1. Use Descriptive Names
Assign clear and descriptive names to dashboard assets to make them easy to identify and manage within the org.
2. Maintain Documentation
Document each dashboard’s business purpose, key metrics, and included visualizations for better maintenance and user onboarding.
3. Bundle Related Assets
Deploy AnalyticsDashboard together with referenced AnalyticsWorkspace and AnalyticsVisualization assets for package integrity.
4. Implement Version Control
Store dashboard metadata in version control systems to track changes, enable rollback, and collaborate across teams.
5. Validate in Sandbox
Test deployments in a sandbox to catch configuration or compatibility issues before releasing to production users.
6. Regular Reviews
Periodically review dashboard assets to remove obsolete items, update documentation, and ensure alignment with business requirements.
7. Collaborate with Stakeholders
Work closely with business and analytics teams to ensure dashboards meet business needs and use authoritative data sources.
8. Monitor Deployments
Check deployment logs for errors or warnings and resolve issues related to dependencies or schema mismatches promptly.
9. Consistent Formatting
Standardize the formatting of all dashboard definitions to improve readability and ease of maintenance.
10. Provide Training
Offer training and resources for users and admins working with AnalyticsDashboard assets to maximize adoption and value.
Conclusion
The AnalyticsDashboard metadata type brings Tableau Next dashboards into Salesforce’s modern metadata-driven deployment model. By following best practices in naming, packaging, validation, and documentation, administrators can ensure robust, secure, and scalable analytics delivery while supporting continuous improvement and business insight generation.