Analytics Templates Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Template at a High Level
The Process at a Glance
Template Dependencies
Customizing Downstream Apps Prohibits Upgrades
Step 1: Create (or update) the WaveTemplate Object
Step 5: Test the Template
Step 6: Share the Template
Step 7: Create New (Downstream) Apps from the Template
Features Not Supported in This Release
Newer Version Available
Introducing Analytics Templates
A template is a prototype of an app that others can use to create apps.
The word “app” is used so often in this context, that we want to distinguish its two meanings right away.
There is the app you start with, the one on which you want to base your template. To avoid confusion going forward, we will call this the master app, and we’ll say that you templatize this master app by making a template out of it.
Then there are the apps that users will create based on your template. We’ll call these the downstream apps.
Note
-
Template at a High Level
You design an app based on your ideas about the best way to visualize a specific type of content. Creating an app from scratch requires a fair amount of know-how: you have to load and transform the data, create lenses from the data, and design the dashboards. To spare other users that trouble, you can share the app you designed, and others can benefit from its datasets, lenses, and dashboards built with your existing Salesforce data. -
Template Dissected
At a more detailed level, two types of components make up a WaveTemplate object. -
The Process at a Glance
The template creation process follows seven major stages, which form the structure of this document. -
Template Dependencies
A template is dependent on its master app; if the master app is deleted, so is the folderSource, and any PUT calls to the Metadata API to update the template will fail. Likewise, the resulting apps built using the template depend on that template. The template cannot be deleted as long as downstream apps that were built from it still exist. -
Customizing Downstream Apps Prohibits Upgrades
If the master app is altered in any way, making an API PUT call to the /services/data/v39.0/wave/templates/<templateId or APIName> endpoint propagates the changes to the template. The template is saved with a new version (for example, the version is incremented from 1.0 to 2.0). Users running apps based on that template are prompted to update their apps.