AppFrameworkTemplateBundle

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

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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 by 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 dashboasrds. 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 be named withthe 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 following suffixes.

Suffix	Component Type
.json	JSON file
.html	HTML file

Version

AppFrameworkTemplateBundle components are available in API version 64.0 and later.

Special Access Rules

Definitions can be created in both managed and unmanaged packages.

Fields

Field Name	Description
assetVersion	Field Type double Description The API version of the template bundle.
description	Field Type string Description The description for the template.
label	Field Type string Description Required The label for the template.
maxAppCount	Field Type int Description The maximum number of apps that can be created from this template.
templateBadgeIcon	Field Type string Description The badge icon for template. This must be a `.png` file type.
templateStatus	Field Type string Description The status of the template.
templateSubtype	Field Type string Description The subtype of the template.
templateType	Field Type string Description The type of the template.

Declarative Metadata Sample Definition

The following 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>

Wildcard Support in the Manifest File

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

Metadata API Developer Guide