WaveComponent

Represents the WaveComponent object in the Analytics application.

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 components, consider that:

  • Modifications to the .wcomp component are unsupported.

Parent Type 

This type extends WaveDashboard and inherits its fields.

File Suffix and Directory Location 

WaveComponent components have the suffix .wcomp and are stored in the wave folder.

Version 

Introduced in API version 51.0.

Fields 

application 

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

description 

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

masterLabel 

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

templateAssetSourceName 

  • Type: string
  • Required: No
  • Description: Links the component 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 WaveComponent component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WaveComponent 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>Component1</masterLabel>
6    <description>Component description</description>
7</WaveComponent>

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.