DigitalExperienceConfig

Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

DigitalExperienceConfig components have the suffix .digitalExperienceConfig and are stored in the digitalExperienceConfigs folder.

Version 

Introduced in API version 56.0.

Special Access Rules 

You can use DigitalExperienceConfig for enhanced LWR sites created after the Winter ’23 release.

Fields 

label 

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

site 

  • Type: Site
  • Required: Yes
  • Description: Required.

space 

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

Site Type 

Represents site-related information, such as the URL path prefix.

Fields 

urlPathPrefix 

  • Type: string
  • Required: No
  • Description: The first part of the path on the site’s URL that distinguishes this site from other sites. For example, if your site URL is MyDomainName.my.site.com/partners, then partners is the urlPathPrefix.

Declarative Metadata Sample Definition 

The following is an example of a DigitalExperienceConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DigitalExperienceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Capricorn_Coffee</label>
4    <site>
5        <urlPathPrefix>CapricornCoffee</urlPathPrefix>
6    </site>
7    <space>site/Capricorn_Coffee1</space>
8</DigitalExperienceConfig>

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>Capricorn_Coffee1</members>
5        <name>DigitalExperienceConfig</name>
6    </types>
7    <version>56.0</version>
8</Package>

Usage 

To retrieve and deploy DigitalExperienceConfig, use legacy sfdx commands.

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.