Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
AppFrameworkTemplateBundle
Parent Type
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 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.jsonApp 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.
| Suffix | Component Type |
|---|---|
| .json | JSON file |
| .html | HTML file |
Version
AppFrameworkTemplateBundle components are available in API version 64.0 and later.
Special Access Rules
Create definitions in both managed and unmanaged packages.
Fields
| Field Name | Description |
|---|---|
| assetVersion |
|
| description |
|
| label |
|
| maxAppCount |
|
| templateBadgeIcon |
|
| templateStatus |
|
| templateSubtype |
|
| templateType |
|
Declarative Metadata Sample Definition
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>Wildcard Support in the Manifest File
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.