Tableau CRM Templates Developer Guide

Why Tableau CRM Templates?
Choose Your Tool
The Process at a Glance
Prerequisites
Step 1: Create 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
Step 8: Update an Existing Template
Share Tableau CRM Assets Between Apps
Features Not Supported in This Release
API End-of-Life
Appendix
PDF

Newer Version Available

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

Prerequisites

Take care of these tasks before creating Tableau CRM templates.
Licenses and Permission Sets

Make sure you and members of your team each have a Tableau CRM platform license--either Tableau CRM Growth or Tableau CRMs Plus.

Assign the following permission sets to yourself and members of your team:

  • For Tableau CRM Growth licenses, Tableau CRM Admin
  • For Tableau CRM Plus licenses, Tableau CRM Plus Admin
Org preferences

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

Developer Edition Org Namespace

Set up a namespace for your development org to enable the use of Managed Packages. Do this before creating any Tableau CRM assets.

CLI Developers
To use CLI for template development, enable the Dev Hub, which lets you create and manage SFDX scratch orgs. Also, install the Analytics CLI Plugin:
  1. Enable Dev Hub in your org. See Enable Dev Hub in Your Org.
  2. Install the Salesforce Command-Line Interface (CLI). See Install the Salesforce CLI.
  3. Create a Salesforce DX project. See Create a Salesforce DX Project.
  4. Create a scratch org. See Create Scratch Orgs.
  5. Install the CLI Analytics plugin by running the command sfdx plugins:install @salesforce/analytics.
  6. Verify the installation by listing the available analytics commands. Run the command sfdx analytics --help.

For a reference to all Analytics CLI available commands, see the Salesforce Analytics CLI Plugin Command Reference.

Workbench Developers
  • Tableau CRM REST API Access. Refer to the documentation on Authentication to the Tableau CRM 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.
Tableau CRM REST API access

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

Source app and its ID

Typically, you build an app and it becomes a source app when you create a template from it. You can also use a template to create a source app. However you create the app, note the 18-character app ID in the URL. It’s shown here in boldface:https://salesforce.com/analytics/wave/wave.apexp?tsid=2x0x0002xxx#application/00l0b000002AynIAAS. The ID becomes the folderId you use as you work with the WaveTemplate object.

Create a Source App From Scratch
Use Tableau CRM Analytics Studio to build an app with lenses, dashboards, datasets, recipes, and the default Salesforce dataflow.
Create a Source App From a Template
  1. Create an app from the template using the wizard. Use CLI or Workbench to create the app if the wizard doesn't expose all the variables, and you need to answer them differently to create all app assets. In CLI, use an analytics:app:create command. In Workbench, you can use a Tableau CRM REST API call.
  2. Next, turn the app into the source app by coupling it with the template.
    • With CLI, use analytics:template:update with the folderSourceID. See Step 8: Update an Existing Template.
    • In Workbench, use the following PUT call to update the template’s folderSourceID to the app that you just created:
      Here’s the request body:
Now, the new app becomes the source app in the org. Any updates made to the folder assets in the new source app are tied to the template.