Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

WaveDashboard

Represents the WaveDashboard object in the Analytics application. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

When using Metadata API to work with Analytics dashboards, consider that:

Modifications to the .wdash component are unsupported.
Modifying or removing conditional formatting from the source org or .wdash component doesn’t cause issues while deploying.
Removing steps from the .wdash component causes deployment to the destination org to fail because the source dashboard fails validation.

File Suffix and Directory Location

WaveDashboard components have the suffix .wdash and are stored in the wave folder.

Version

WaveDashboard components are available in API version 37.0 and later.

Fields

Field Name	Field Type	Description
application	string	Required. The internal name of the application.
dateVersion	integer	The date version for the dashboard. Only available in v55.0 and above.
description	string	The dashboard description that appears in the user interface.
masterLabel	string	Required. The dashboard name that appears in the user interface.
templateAssetSourceName	string	Links the dashboard to the template used to create it. Null for assets not created from a template.

Declarative Metadata Sample Definition

The following is an example of a WaveDashboard component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WaveDashboard xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3  <content xsi:nil="true"/>
4  <application>dev__app</application>
5  <masterLabel>Dashboard1</masterLabel>
6  <description>somedesc</description>
7</WaveDashboard>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide