AppFrameworkTemplateBundle

Represents the app framework template bundle. Use these templates for and Tableau Next assets.

This type extends Metadata and inherits its fields.

An app framework template bundle is a folder that contains definition files for a template. Unlike other metadata components, a AppFrameworkTemplateBundle component isn’t represented with a single component file, but instead by a collection of JSON and other definition files. Each definition file represents a resource in a template, such as semantic models, workspaces, visualizations, and dashboards. For example, this directory structure shows the hierarchy of the folders and files for one app framework template definition, myTemplate.

1appTemplates
2  myTemplate
3    template-info.json
4    create-chain.json
5    rules.json
6    variables.json 
7    layout.json
8    workspaces
9      myWorkspace.json
10    dashboards
11      myDashboard.json

App framework template bundles must be under a top-level folder that’s named appTemplates. Each bundle must have its own subfolder under the appTemplate folder and 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 these suffixes.

Introduced in API version 64.0.

Create definitions in both managed and unmanaged packages.

• Type: double
• Required: No
• Description: The API version of the template bundle.

• Type: string
• Required: No
• Description: The description for the template.

• Type: string
• Required: Yes
• Description: Required

• Type: int
• Required: No
• Description: The maximum number of apps that can be created from this template.

• Type: string
• Required: No
• Description: The badge icon for the template. This must be a .png file type.

• Type: string
• Required: No
• Description: The status of the template.

• Type: string
• Required: No
• Description: The subtype of the template.

• Type: string
• Required: Yes
• Description: The type of the template.

This is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3<types>
4    <members>myTemplate</members>
5    <name>AppFrameworkTemplateBundle</name>
6</types>
7<version>64.0</version>
8</Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about the manifest file, see Deploying and Retrieving Metadata with the Zip File.