WaveLens

Represents the WaveLens object in the Analytics application.

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.

This type extends MetadataWithContent and inherits its fields.

WaveLens components have the suffix .wlens 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: string[]
• Required: No
• Description: A reference to the dataset used to create this lens.

• Type: int
• Required: No
• Description: The date version used for this lens.

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

• Type: string
• Required: Yes
• Description: Required. The user interface label name of the dashboard.

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

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The visualization type to be used for this lens.
• Possible values:
  • 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

The following is an example of a WaveLens component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WaveLens 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  <datasets>dev__abc</datasets>
6  <masterLabel>lens1</masterLabel>
7  <description>lens in shared app</description>
8  <visualizationType>hbar</visualizationType>
9</WaveLens>

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.