WaveLens

This type extends to MetadataWithContent metadata type and inherits its content and fullName fields.

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

If a lens is archived (moved to the Recycle Bin), retrieving it doesn't return its metadata. Deploying changes to an archived lens fails with an error stating that the lens is in the Recycle Bin.

Important

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.

File Suffix and Directory Location

WaveLens components have the suffix .wlens and are stored in the wave folder.

Version

WaveLens 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.
datasets	string	A reference to the dataset used to create this lens.
dateVersion	int	The date version used for this lens.
description	string	The dashboard description that appears in the user interface.
masterLabel	string	Required. The user interface label name of the dashboard.
templateAssetSourceName	string	Links the lens to the template used to create it. Null for assets not created from a template.
visualizationType	string	Required. The visualization type to be used for this lens. Valid values are: `calheatmap`—Calendar heat map `comparisontable`—Comparison table `heatmap`—Heat map `hbar`—Horizontal bar `hbarhdot`—Horizontal dot plot `matrix`—Matrix `parallelcoords`—Parallel coordinates `pie`—Donut `pivottable`—Pivot table `scatter`—Scatter plot `stackhbar`—Stacked horizontal bar `stackvbar`—Stacked vertical bar `time`—Time line `valuestable`—Values table `vbar`—Vertical bar `vdot`—Vertical dot plot

Declarative Metadata Sample Definition

The following is an example of a WaveLens component.

<?xml version="1.0" encoding="UTF-8"?>
<WaveLens xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <content xsi:nil="true"/>
  <application>dev__app</application>
  <datasets>dev__abc</datasets>
  <masterLabel>lens1</masterLabel>
  <description>lens in shared app</description>
  <visualizationType>hbar</visualizationType>
</WaveLens>

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.