Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Territory2Settings
File Suffix and Directory Location
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.
Territory2Settings values are stored in a single file named Territory2.settings in the settings directory of the corresponding package directory. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
Territory2Settings is available in API version 32.0 and later.
Special Access Rules
Fields
| Field Name | Field Type | Description |
|---|---|---|
| defaultAccountAccessLevel | string | Sets the default level of access that users have to account records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultCaseAccessLevel | string | Sets the default level of access that users have to case records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultContactAccessLevel | string | Sets the default level of access that users have to contact records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultOpportunityAccessLevel | string | Sets the default level of access that users have to opportunity records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| enableTerritoryManagement2 | boolean | Enables and disables Sales Territories only. If true, Sales Territories is enabled. If
false (default), Enterprise Territory
Management isn’t enabled. Enabling and disabling Sales Territories is
exclusive of all other operations, and the field value must be true before other territory-management operations can
run. Available in API version 47.0 and later. |
| opportunityFilterSettings | Territory2SettingsOpportunityFilter |
Optional. Specifies an Apex class to assign territories to opportunities and whether you want to run it when an opportunity is created. Available in API version 34.0 and later. |
| showTM2EnabledBanner | boolean | If true, a success banner appears on the
Territory Settings page in
Setup. Available in API version 49.0 and later. |
| supportedObjects | Territory2SupportedObject[] |
Sets the user access levels of all objects that support territory assignments in the org. Available in API version 57.0 and later. |
| t2ForecastAccessLevel | string | Sets the access level that users in a parent territory get to the opportunities
assigned to its child territories, regardless of who owns the opportunities. Valid
values are:
Available in API version 49.0 and later. |
| tm2BypassRealignAccInsert | boolean | If true, account assignment rules don’t
run during account insert jobs. Available in API version 53.0 and later. |
| tm2EnableUserAssignmentLog | boolean | If true, when a user is assigned to a
territory, the assignment action is logged. Available in API version 57.0 and later. |
Territory2SettingsOpportunityFilter
This subtype specifies an Apex class that assigns territories to opportunities. You can run the Apex class automatically every time a user creates an opportunity, or run it by using multithreading.
Territory2SupportedObject
Sets the user access levels of all objects that support territory assignments in the org.
| Field Name | Description |
|---|---|
| defaultAccessLevel |
|
| objectType |
|
| state |
|
Declarative Metadata Sample Definition
The following example shows the definition of a Territory2Settings component.
<?xml version="1.0" encoding="UTF-8"?>
<Territory2Settings xmlns="http://soap.sforce.com/2006/04/metadata">
<defaultAccountAccessLevel>Owner</defaultAccountAccessLevel>
<defaultOpportunityAccessLevel>Read</defaultOpportunityAccessLevel>
<defaultCaseAccessLevel>None</defaultCaseAccessLevel>
<defaultContactAccessLevel>Edit</defaultContactAccessLevel>
<enableTerritoryManagement2>true</enableTerritoryManagement2>
<showTM2EnabledBanner>true</showTM2EnabledBanner>
<supportedObjects>
<defaultAccessLevel>Read</defaultAccessLevel>
<state>Disabled</state>
<objectType>Lead</objectType>
</supportedObjects>
<tm2EnableUserAssignmentLog>true</tm2EnableUserAssignmentLog>
<t2ForecastAccessLevel>View</t2ForecastAccessLevel>
</Territory2Settings>Usage
Sales Territories components don’t support packaging or change sets and aren’t supported in CRUD calls.
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.