WaveDashboard

Represents the WaveDashboard object in the Analytics application.

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.
• If a dashboard is archived (moved to the Recycle Bin), retrieving it doesn’t return its metadata. Deploying changes to an archived dashboard fails with an error stating that the dashboard is in the Recycle Bin.

This type extends MetadataWithContent and inherits its fields.

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

Introduced in API version 37.0.

• Type: string
• Required: Yes
• Description: Required. The internal name of the application.

• Type: int
• Required: No
• Description: The date version for the dashboard. Only available in v55.0 and above.

• Type: string
• Required: No
• Description: The dashboard description that appears in the user interface.

• Type: string
• Required: Yes
• Description: Required. The dashboard name that appears in the user interface.

• Type: string
• Required: No
• Description: Links the dashboard to the template used to create it. Null for assets not created from a template.

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>

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.