Analytics Templates Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Why CRM Analytics 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 CRM Analytics Assets Between Apps
Features Not Supported in This Release
Release Notes
API End-of-Life Policy
Appendix
PDF

The Process at a Glance

After creating a source app in CRM Analytics, follow these steps to create and work with a template. The next sections of the developer guide provide details about each step.

Start by developing an app in CRM Analytics Studio. That becomes the source app you use as the basis for your template. We recommend that you complete Steps 1 through 4 and 8 in Microsoft Visual Studio (VS) Code, issuing command line interface (CLI) commands from the tool’s Command Palette and using its JSON editor.

  1. Create the WaveTemplate object and files. Create the first version of the template from the source app.
  2. Retrieve (export) the WaveTemplate object and files. Make the files available on your local file system for editing.
  3. Edit the JSON files. Build the configuration wizard user interface, variables, conditions, and rules into your template by editing the JSON files. You can also customize the wizard with VisualForce and add other enhancements. Use your preferred Integrated Development Environment (IDE) to edit the files, regardless of whether you create them using CLI or VS Code.
  4. Deploy the WaveTemplate object. After editing the files in an IDE, push the them back to your development org for testing. Deploy the object every time you edit the JSON. Pulling the template files back from the development org overwrites the files on your local workstation.
  5. Test the template. Testers can now create apps from the template in Analytics Studio for testing. After getting test results, retrieve the template object files again (Step 2), make further edits (Step 3), and redeploy them (Step 4). It’s an iterative cycle. And every time you change the JSON files, and deploy your template, test the template again.
  6. Share the template with users. Enables creation of apps from the template.
  7. Create apps from the template. Users create apps in Analytics Studio or by installing a managed package. Based on their feedback, continue iterative development of the app and template.
  8. Update an existing template. Update the template after editing source app assets, including dashboards, lenses, datasets, recipes, and dataflows in Analytics Studio.