WaveAnalyticAssetCollection

Represents a collection of Analytics assets.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

WaveAnalyticsAssetCollection components have the suffix .collection and are stored in the wave folder.

Version 

WaveAnalyticsAssetCollection components are available in API version 58.0 and later.

Fields 

collectionType 

  • Type: string
  • Required: Yes
  • Description: The collection type.

color 

  • Type: string
  • Required: Yes
  • Description: The display color for the collection.

description 

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

folder 

  • Type: string
  • Required: No
  • Description: The internal API name of the folder or application.

items 

label 

  • Type: string
  • Required: Yes
  • Description: The label for the collection.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: The master label for this component. This display value is the internal label that isn’t translated.

shares 

  • Type: FolderShare[]
  • Required: No
  • Description: The folder sharing rules.

WaveAnalyticAssetCollectionItem Type 

WaveAnalyticAssetCollectionItem represents an Analytics asset item.

Fields 

asset 

  • Type: string
  • Required: No
  • Description: The asset name.

assetType 

  • Type: string
  • Required: No
  • Description: The asset type.

sortOrder 

  • Type: int
  • Required: No
  • Description: The sort order for the asset.

Declarative Metadata Sample Definition 

The following is an example of a WaveAnalyticAssetCollection component.

1<?xml version="1.0" encoding="UTF-8"?>  
2<WaveAnalyticsAssetCollection xmlns="http://soap.sforce.com/2006/04/metadata">
3  <collectionType>static</collectionType>
4  <color>#1b96ff</color>
5  <description>A collection of my Dashboards</description>
6  <folder>Shared</folder>
7  <label>My Dashboard Collection</label>
8  <items>
9     <item>
10        <asset>Dashboard One</asset>
11        <assetType>dashboard</assetType>
12        <sortOrder>1</sortOrder>
13     </item>
14     <item>
15        <asset>Dashboard Two</asset>
16        <assetType>dashboard</assetType>
17        <sortOrder>2</sortOrder>
18     </item>
19  </items>
20  <shares>
21    <accessLevel>EditAllContents</accessLevel>
22    <sharedTo>shareswith@org.ee</sharedTo>
23    <sharedToType>User</sharedToType>
24  </shares>
25</WaveAnalyticsAssetCollection>

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.