BranchManagementSettings

Represents the branch management settings for an org. This type extends the Metadata metadata type and inherits its fullName field.

Parent Type and Manifest Access

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

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

BranchManagementSettings values are stored in the BranchManagement.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version

BranchManagementSettings components are available in API version 51.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name	Description
associateAccountWithBranch	Field Type boolean Description Automatically associates new accounts with the user’s current branch by creating branch unit customer records. The default value is `false`.

Declarative Metadata Sample Definition

The following is an example of a BranchManagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<BranchManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <associateAccountWithBranch>true</associateAccountWithBranch>
4</BranchManagementSettings>

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>BranchManagement</members>
5        <name>Settings</name>
6    </types>
7</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide