WaveTemplateBundle

Represents an Analytics template bundle, which can be used to create Analytics apps. A bundle contains an Analytics template definition and all its related resources.This type extends the Metadata metadata type and inherits its fullName field.

We provide this feature to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Because pilot programs are subject to change, we can’t guarantee acceptance. This pilot feature isn’t generally available, as referenced in this document or in press releases or public statements. We can’t guarantee that it will become generally available within any particular time frame or at all. Make your purchase decisions only on the basis of generally available features. Services provided by the Analytics REST API are subject to change. Support is not provided.

Note

File Suffix and Directory Location

An Analytics template bundle is a folder that contains definition files for a template. Unlike other metadata components, a WaveTemplateBundle component isn’t represented by a single component file, but instead by a collection of JSON and CSV definition files. Each definition file represents a resource in a template, such as lenses, dashboards, dataflows, and comma-separated values. For example, this directory structure shows the hierarchy of the folders and files for one Analytics Template definition, template1.

1waveTemplates
2    template1
3        template-info.json 
4        variables.json 
5        ui.json 
6        extFiles
7            PostalCodes.csv

Analytics template bundles must be under a top-level folder that’s named waveTemplates. Each bundle must have its own subfolder under the waveTemplates folder and be named with the template's fully qualified API name. The bundle folder must contain a template-info.json file to specify the metadata about the template and the references to other definition files. An entire bundle doesn’t have a suffix and definition files can have one of the following suffixes.

Suffix	Component Type
.json	JavaScript Object Notation
.csv	Comma-Separated Values

Version

WaveTemplateBundle components are available in API version 35.0 and later.

Special Access Rules

Definitions can be created in both managed and unmanaged packages.

Fields

Field Name	Field Type	Description
assetIcon	string	The icon to use by default for new Analytics apps based on this template. Valid values are `1.png` through `20.png`.
description	string	The specification of the template.
label	string	Required. The label of the template.
templateType	string	Required. The type of the template. Valid values are: `App` `Dashboard` `Lens`

Metadata API Developer Guide

WaveTemplateBundle

File Suffix and Directory Location

Version

Special Access Rules

Fields