Analytics Templates Developer Guide

Introducing Analytics Templates
Quick Start
Prerequisites
Step 1: Create (or update) the WaveTemplate Object
Step 2: Retrieve (Export) the WaveTemplate Object
Step 3: Edit the JSON Files
Step 4: Deploy 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
Appendix
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Prerequisites

Make sure you're all set with these five prerequisites before you go forth and create templates.
Permission set licenses

Most likely you already have an Analytics platform license for your org (either one InsightsStarter or one Analytics platform license will do the job). The license is required to create dashboards, lenses, and datasets.

  • Assign the following permission set licenses:
    • Analytics Builder
  • Assign the following permission sets:
    • Use Templated App
    • Manage Templated App
    • Manage Analytics
Org preferences

Set your Org Preferences to enable Analytics Templates. In the Admin Setup page, under Settings, select Enable Analytics Templates. You'll need this to create Analytics Template assets in the form of JSON files.

Developer Edition Org Namespace

Set up a namespace for your DE org to enable the use of Managed Packages. It is recommended that you do this before creating any Analytics assets.

Analytics REST API access

Refer to the documentation on Authentication to the Analytics REST API to access and use the API.

Metadata API access

Refer to the Metadata API Developer's Guide to access and use the Metadata API.

Master app and its ID

Typically, you build an app and it becomes a master app when you decide to templatize it. However, if you have a template but no master app in your org, you may find yourself making a master app from a template.

Create the app you plan to templatize:

  1. Build an app with lenses, dashboards, datasets, and the default Salesforce dataflow.
  2. Note the app ID in the URL; it becomes the folderId you will use as you work with the WaveTemplate object.

Create a master app from a template if you don't have a master app for your org:

  1. Create an app from the template using the wizard.

    You can also create an app from the template by using a direct Analytics REST API call. Use this option if the wizard doesn't expose all the variables, and you need to answer them differently to create all the app's assets.

  2. Turn this app into the master app by updating the template with a PUT call with the following syntax:

    Request Body:

    This updates the template's folderSourceId to the master app's folder. This constitutes assigning the master app.

    You can only have one master app per org, so you can only do this for one app.

    Note