Metadata Type: WaveAnalyticAssetCollection

WaveAnalyticAssetCollection is a metadata type in Salesforce that represents a curated collection of CRM Analytics (formerly Wave) assets, such as dashboards, datasets, and lenses. This metadata type allows organizations to group related analytics items together, making it easier for users to discover, organize, and share vital business intelligence and insights within their Salesforce instance.

Overview

The WaveAnalyticAssetCollection metadata type was introduced in API version 58.0 and is part of Salesforce's efforts to enhance data discovery and analytics management within the platform. It enables administrators to create customized, color-coded groupings of analytics assets and define sharing rules for specific folders or applications. This functionality is particularly useful for organizations that need to maintain organized analytics workspaces and ensure targeted access to critical data visualizations.

Key Features

• Custom curation of CRM Analytics assets like dashboards and lenses
• Support for detailed sharing rules and access levels
• Flexible configuration options including UI color and sorting
• Integration with Salesforce's overarching CRM Analytics folder structure

Structure and Components

A WaveAnalyticAssetCollection typically consists of the following components:

• Source Folder: The internal API name of the folder or application housing the collection
• Asset Items: A defined list of specific analytics assets included in the collection, along with their types and display sort order
• Sharing Rules: Definitions of which users, roles, or groups have access to the collection and their corresponding access levels
• UI Configurations: Settings for display elements, such as the label, description, and custom color of the collection

Deployment Considerations

When deploying WaveAnalyticAssetCollection metadata, administrators should be aware of several potential issues:

1. Asset Dependencies

Ensure that all analytics assets (dashboards, lenses, datasets) referenced in the items list exist in the destination org. If an asset is missing or has an incorrect API name, the deployment may fail or lead to broken collections.

2. Folder References

Verify that the parent folder or CRM Analytics application specified in the metadata exists in both environments. Deploying a collection to an uncreated or unavailable folder can lead to deployment validation errors.

3. User and Group Shares

Check that the users, roles, or public groups referenced in the sharing rules exist in the target org. Mismatched or non-existent sharing targets will cause the deployment of the sharing configurations to fail.

4. Existing Collections

Be cautious when overwriting existing collections, as changes to items or sharing rules may affect how end-users currently access their daily reports. Consider using a sandbox environment to test changes to critical business intelligence collections before deploying to production.

5. API Versioning

Because this metadata type was formalized in API version 58.0, verify that your deployment manifest (package.xml) uses API version 58.0 or later to ensure the metadata is successfully identified and processed by the platform.

Best Practices for Salesforce Administrators

To effectively use and manage WaveAnalyticAssetCollection metadata, Salesforce administrators should follow these best practices:

1. Document Your Collections

Maintain clear documentation of all analytics collections, including their target audience, the assets they contain, and why they were grouped. This documentation will be invaluable for governance and onboarding new data consumers.

2. Use Descriptive Labels

Choose clear and descriptive names for your WaveAnalyticAssetCollection instances. This will make it easier for business users to understand the collection's purpose at a glance and simplify navigation across workspaces.

3. Implement Strategically

If you're introducing analytics collections to an existing org, implement them strategically. Start with a small set of high-impact executive dashboards and expand as you verify user adoption and gather feedback.

4. Leverage Sandboxes

Always build and test new WaveAnalyticAssetCollection configurations in a CRM Analytics-enabled sandbox environment before deploying to production. This allows you to verify that sorting and access levels behave as expected.

5. Monitor and Optimize

Regularly review the usage and relevance of your collections. Look for opportunities to optimize them by removing outdated dashboards or consolidating overlapping collections to reduce UI clutter for your end users.

6. Version Control

Use a version control system to track changes to your .collection metadata files. This practice allows you to roll back changes if needed and maintain an audit trail of asset and sharing rule modifications.

7. Align with Data Governance

Work closely with your organization's data governance or center of excellence team to ensure that the collections accurately reflect approved reporting structures and comply with internal data visibility standards.

8. Regular Audits

Conduct periodic audits of your WaveAnalyticAssetCollection sharing settings to ensure they remain secure and accurate. Remove access for users who have changed roles or left the organization to maintain strict data security.

9. Consistent Styling

Establish and apply a consistent color-coding strategy for collections (e.g., blue for sales, green for finance) to help users visually distinguish between different business domain analytics directly from the user interface.

10. Training and Enablement

Provide brief training and comprehensive guidance for business users who will be consuming the analytics collections. This ensures consistent understanding of where to find single sources of truth across the organization.

Conclusion

The WaveAnalyticAssetCollection metadata type is a powerful tool for Salesforce administrators to customize and streamline the discovery of CRM Analytics assets within their organizations. By understanding its structural capabilities, potential deployment dependencies, and following best practices, administrators can effectively leverage this feature to enhance their data-driven decision-making and reporting workflows. As with any complex BI configuration, careful planning, strategic sharing, and ongoing curation are key to the successful implementation and maintenance of WaveAnalyticAssetCollection metadata.