UIBundle

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

UIBundle components have the suffix .uibundle-meta.xml and are stored in the uiBundles/your_app folder.

Version

UIBundle components are available in API version 66.0 and later.

Special Access Rules

Ensure that the Salesforce app domain is enabled for your org in React Development with Salesforce Multi-Framework in Setup.

The UIBundle metadata type can contain up to 2,500 files.

Fields

Field Name	Description
description	Field Type string Description A description of what the web application does.
isActive	Field Type boolean Description Required. Specifies whether the web application is accessible (`true`) or not (`false`).
isProtected	Field Type boolean Description For internal use only.
masterLabel	Field Type string Description Required. Specifies the web-application name that appears in the UI.
target	Field Type string Description Specifies the Salesforce target where the app is supported. Valid values are: `AppLauncher`: Deprecated in API version 67.0. Instead, use `CustomApplication`. Makes the app available in the App Launcher. `CustomApplication`: When used with the CustomApplication metadata type, makes the app available in the App Launcher. This is the default target if you don’t specify a value. Available in API version 67.0 and later. `Experience`: Indicates that the app is an external-facing site or portal and makes it available in the Digital Experiences app.
version	Field Type string Description Required. Indicates the version of the web application.

Declarative Metadata Sample Definition

The following is an example of a UIBundle component.

1<UIBundle xmlns="http://soap.sforce.com/2006/04/metadata">
2    <masterLabel>Customer Portal</masterLabel>
3    <description>Customer self-service portal built with React.</description>
4    <isActive>true</active>
5    <target>Experience</target>
6    <version>1</version>
7</UIBundle>

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>*</members>
5        <name>UIBundle</name>
6    </types>
7    <version>66.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