AppFrameworkApp | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

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

File Suffix and Directory Location

AppFrameworkApp components have the suffix .appFrameworkApp and are stored in the appFrameworkApps folder.

Version

AppFrameworkApp components are available in API version 68.0 and later.

Fields

Field Name	Description
appAssetVersion	Field Type double Description The API version of the assets in the app.
appTemplate	Field Type string Description The name of the template used to install the app.
description	Field Type string Description The description of the app.
installedAssets	Field Type AppFrameworkInstalledAsset[] Description The installed assets associated with the app. An app has 1 or more installed assets.
label	Field Type string Description Required The label for the app.
templateSubType	Field Type string Description The subtype of the template used to install the app. Valid values include Tableau, DataCloud, AgentforceAnalytics, Flow, Dashboard, Visualization, SemanticModel, Metric, and Extension.
templateType	Field Type string Description The type of the template used to install the app. Valid values include App and Component.
templateVersion	Field Type string Description The version of the template used to install the app.

AppFrameworkInstalledAsset

An installed asset in an app.

Field Name	Description
appAssetVersion	Field Type double Description The API version of the installed asset.
asset	Field Type string Description Required The name of the installed asset.
tags	Field Type string Description A list of the tags for the installed asset.
templateAssetSourceName	Field Type string Description Required The name of the template used to install this asset.
type	Field Type string Description The type of the installed asset. Valid values include Dashboard and Workspace.

Declarative Metadata Sample Definition

The following is an example of a AppFramework component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AppFrameworkApp xmlns="http://soap.sforce.com/2006/04/metadata">
3    <appAssetVersion>68.0</appAssetVersion>
4    <appTemplate>basic_template</appTemplate>
5    <description>Basic template app</description>
6    <installedAssets>
7        <appAssetVersion>68.0</appAssetVersion>
8        <asset>Workspace1</asset>
9        <templateAssetSourceName>Workspace1</templateAssetSourceName>
10        <type>Workspace</type>
11    </installedAssets>
12    <installedAssets>
13        <appAssetVersion>68.0</appAssetVersion>
14        <asset>Dashboard1</asset>
15        <templateAssetSourceName>Dashboard1</templateAssetSourceName>
16        <type>Dashboard</type>
17    </installedAssets>
18    <installedAssets>
19        <appAssetVersion>68.0</appAssetVersion>
20        <asset>Dashboard2</asset>
21        <templateAssetSourceName>Dashboard2</templateAssetSourceName>
22        <type>Dashboard</type>
23    </installedAssets>
24    <installedAssets>
25        <appAssetVersion>68.0</appAssetVersion>
26        <asset>Dashboard3</asset>
27        <templateAssetSourceName>Dashboard3</templateAssetSourceName>
28        <type>Dashboard</type>
29    </installedAssets>
30    <label>Basic Test Template app</label>
31    <templateType>APP</templateType>
32    <templateVersion>1.0</templateVersion>
33</AppFrameworkApp>

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>Dashboard1</members>
5        <members>Dashboard2</members>
6        <members>Dashboard3</members>
7        <name>AnalyticsDashboard</name>
8    </types>
9    <types>
10        <members>Workspace1</members>
11        <name>AnalyticsWorkspace</name>
12    </types>
13    <types>
14        <members>BasicTemplate_app</members>
15        <name>AppFrameworkApp</name>
16    </types>
17    <version>68.0</version>
18</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.